{"id":23186071,"url":"https://github.com/termosa/ts-session","last_synced_at":"2025-04-05T04:44:53.839Z","repository":{"id":57381140,"uuid":"66528244","full_name":"termosa/ts-session","owner":"termosa","description":"A client-side web session controller for AngularJS","archived":false,"fork":false,"pushed_at":"2016-08-28T03:40:47.000Z","size":8,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-10T13:48:47.650Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/termosa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-25T05:39:38.000Z","updated_at":"2016-08-25T14:42:32.000Z","dependencies_parsed_at":"2022-09-21T17:13:21.637Z","dependency_job_id":null,"html_url":"https://github.com/termosa/ts-session","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/termosa%2Fts-session","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/termosa%2Fts-session/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/termosa%2Fts-session/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/termosa%2Fts-session/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/termosa","download_url":"https://codeload.github.com/termosa/ts-session/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289400,"owners_count":20914464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-18T10:14:23.638Z","updated_at":"2025-04-05T04:44:53.818Z","avatar_url":"https://github.com/termosa.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TS-Session\n\nAngular TS-Session is a client-side web session controller for [AngularJS](https://angularjs.org/).\n\nTS-Session can help you to manage your session data. It is easily configured to use any synchronous storage. And it provides simple interface for storing multiple sessions (can be useful for OAuth standard and similar to it).\n\n## Provider API\n\n### tsSessionProvider.safeMode(\u0026lt;bool\u003e)\n\nWhile it's enabled it prevents overriding session or loading nonexistent session by throwing error.\n\n*By default safe mode is enabled.*\n\n``` js\nmodule\n.config([\n  'tsSessionProvider',\n  function(tsSessionProvider) {\n    tsSessionProvider.setSafe(\u003c 1: true, 2: false \u003e);\n  }\n])\n.factory('createSession', [\n  'tsSession',\n  function(Session) {\n    var sessionId = 'user';\n    var nonexistentSessionId = 'foo';\n\n    Session.create(sessionId);\n    Session.create(sessionId); // 1: throws an error, 2: returns the same session instance\n\n    Session.get(nonexistentSessionId); // 1: throws an error, 2: creates new session\n  }\n]);\n```\n\n### tsSessionProvider.setStorage(\u0026lt;string|object\u003e)\n\nDefines strategy for saving session. By default it stores data in JavaScript.\n\n``` js\nmodule\n.factory('sessionStorage', [\n  '$window',\n  function($window) {\n    var sessionKey = 'session';\n    var storage = $window.localStorage;\n    var JSON = $window.JSON;\n\n    return {\n      save: function(data) {\n        storage.setItem(sessionKey, JSON.stringify(data));\n      },\n      load: function() {\n        return JSON.parse(storage.getItem(sessionKey));\n      },\n      drop: function() {\n        storage.removeItem(sessionKey);\n      }\n    };\n  }\n])\n.config([\n  'tsSessionProvider',\n  'sessionStorage',\n  function(tsSessionProvider, sessionStorage) {\n    tsSessionProvider.setStorage(sessionStorage);\n    // or you can pass the service name only\n    tsSessionProvider.setStorage('sessionStorage');\n  }\n]);\n```\n\n## Service API\n\n### tsSession.create(\u0026lt;id\u003e, [session])\n\nCreates new session.\n\nSynonyms: ```new Session(\u003cid\u003e, \u003csession\u003e)```, ```Session.create(\u003cid\u003e, \u003csession\u003e)```.\n\n``` js\nmodule\n.factory('userSession', [\n  'tsSession',\n  function(Session) {\n    var session = new Session('user');\n    // or Session.create('user')\n    // or Session('user')\n    session.isAuthenticated = function() {\n      return !!this.get('id');\n    };\n    return session;\n  }\n]);\n```\n\n### tsSession.has(\u0026lt;id\u003e)\n\nChecks whether there is a session specified by ```id``` and returns ```true``` or ```false```.\n\n``` js\nmodule\n.factory('userSession', [\n  '$window',\n  'tsSession',\n  function($window, Session) {\n    var Date = $window.Date;\n\n    if (Session.has('user')) {\n      return Session.get('user');\n    }\n\n    return Session.create('user', {\n      session_created: Date.now()\n    });\n  }\n]);\n```\n\n### tsSession.get(\u0026lt;id\u003e)\n\nReturns session if it exists. Otherwise returns ```undefined``` or throws error if in **safe** mode.\n\n``` js\nmodule\n.run([\n  'tsSession',\n  function(Session) {\n    Session.create('user:roles', ['guest']);\n  }\n])\n.factory('authorize', [\n  'tsSession',\n  'acl'\n  function(Session, acl) {\n    var roles = Session.get('user:roles');\n    return function(action) {\n      // roles.get() // returns the actual data\n      return acl.authorize(action, roles.get());\n    };\n  }\n]);\n```\n\n### tsSession.drop(\u0026lt;id|object\u003e)\n\nRemove session.\n\n``` js\nmodule\n.factory('account', [\n  '$http',\n  'tsSession',\n  'userSession',\n  function($http, Session, userSession) {\n    function create() { ... }\n\n    function remove() {\n      var id = userSession.get('id');\n      return $http.delete('/api/account/' + id)\n        .then(function() {\n          Session.drop(userSession);\n          // or Session.drop(userSession.getId());\n        });\n    }\n\n    return {\n      create: create,\n      remove: remove\n    };\n  }\n]);\n```\n\n## Session API\n\n### session.getId()\n\nReturns the ID of session\n\n``` js\nmodule\n.run([\n  'tsSession',\n  function(Session) {\n    var session = new Session('user');\n    session.getId(); // returns \"user\"\n  }\n]);\n```\n\n### session.get([key])\n\nReturns session data if ```key``` is not defined or value of session property with specified ```key```.\n\n``` js\nmodule.run([\n  'tsSession',\n  function(Session) {\n    var session = new Session('user', { id: 1, name: 'John' });\n    session.get(); // returns { id: 1, name: \"John\" }\n    session.get('name'); // returns \"John\"\n  }\n]);\n```\n\n### session.set(\u0026lt;key|object\u003e, [value])\n\nStores data. If ```key``` is specified it creates a property with the name defined by ```key``` and sets it to the value of second argument. If ```key``` is object **set** will copy all of the properties to the session.\n\nReturns session instance, so you can chain execution of session methods;\n\n``` js\nmodule.run([\n  'tsSession',\n  function(Session) {\n    var session = new Session('user');\n    session\n      .set({ id: 1 })\n      .set('name', 'John')\n      .get(); // returns { id: 1, name: \"John\" }\n  }\n]);\n```\n\n### session.del(\u0026lt;key\u003e)\n\nDeletes the property specified by ```key```.\n\nReturns session instance, so you can chain execution of session methods;\n\n``` js\nmodule.run([\n  'tsSession',\n  function(Session) {\n    var session = new Session('user', { id: 1, name: 'John' });\n    session.del('name');\n    session.get(); // returns { id: 1 }\n  }\n]);\n```\n\n### session.reset()\n\nDrops all of the data in the session.\n\nReturns session instance, so you can chain execution of session methods;\n\n``` js\nmodule.run([\n  'tsSession',\n  function(Session) {\n    var session = new Session('user', { id: 1, name: 'John' });\n    session.reset();\n    session.get(); // returns {}\n  }\n]);\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftermosa%2Fts-session","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftermosa%2Fts-session","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftermosa%2Fts-session/lists"}