{"id":15601162,"url":"https://github.com/hacknlove/safeapi-client","last_synced_at":"2025-10-18T06:06:37.070Z","repository":{"id":35043702,"uuid":"200034584","full_name":"hacknlove/safeapi-client","owner":"hacknlove","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-04T08:22:37.000Z","size":756,"stargazers_count":2,"open_issues_count":12,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-09T08:47:52.655Z","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/hacknlove.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":"2019-08-01T11:03:21.000Z","updated_at":"2024-04-25T02:52:36.000Z","dependencies_parsed_at":"2023-01-15T12:38:42.460Z","dependency_job_id":null,"html_url":"https://github.com/hacknlove/safeapi-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacknlove%2Fsafeapi-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacknlove%2Fsafeapi-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacknlove%2Fsafeapi-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hacknlove%2Fsafeapi-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hacknlove","download_url":"https://codeload.github.com/hacknlove/safeapi-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240810879,"owners_count":19861321,"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-10-03T02:19:00.714Z","updated_at":"2025-10-18T06:06:32.020Z","avatar_url":"https://github.com/hacknlove.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# safeapi-client\n\n## Install\n```\nnpm i safeapi-client\n```\n\n## Usage\n```javascript\nimport safeApi from 'safeapi-client'\nsafeApi.server = 'https://example.com/'\nasync function example1 () {\n  safeApi.conf.server = 'https://example.com/api'\n  await safeApi.createKey()\n  safeApi.setPlainPassword('password')\n  localStorage.keys = safeApi.toText()\n  // ...\n\n  const [ response, error ] = safeApi.fetch('endpoint', options) // https://example.com/endpoint\n}\n```\n\n```javascript\nimport safeApi from 'safeapi-client'\n\nasync function example1 () {\n  safeApi.server = 'https://example.com/'\n  safeApi.setPlainPassword('password')\n  safeApi.fromText(localStorage.keys)\n\n  const [ response, error ] = safeApi.fetch('endpoint', options) // https://example.com/endpoint\n}\n```\n\n## API\n\n### safeApi.conf.server\nThe prefix to the fetchs.\n`safeApi.server` defaults to `''`\n\n### safeApi.conf.expiresIn\nThe expiration time, in seconds, of the signatures. defaults to 120 seconds.\n\n### safeApi.conf.checkInterval\nThe interval in seconds to check, against the server, that the key is still valid. defaults to 300 seconds.\nEach time, a fetch is done, the interval resets.\n\n### safeApi.publicKey.pem\nThe public PEM. Or '' if not key has been created or set.\n\n### safeApi.publicKey.uuid\nThe UUID that uses the server to identify the public key\n\n### createKey([data, [algorithm]])\nCreates a new pair of keys and upload the public one to the server that should include `safeapi-server`.\n\nYou can put in `data` any data you need, but you must let `data.pem` free, because it is used to upload the public key.\n\nReturns a promise that will be resolved to `[uuid, error]`\n\n`algorithm` can be one of:\n\n* `'RS256'`\n* `'RS384'`\n* `'RS512'`\n* `'PS256'`\n* `'PS384'`\n* `'PS512'`\n* `'ES256'`\n* `'ES384'`\n* `'ES512'`\n\n### renewKey([data, [algorithm]])\nCreates a new pair of keys and upload the public one to the server, to update the key assigned to the current `uuid`\n\nYou can put in `data` any data you need, but you must let `data.pem` free, because it is used to upload the public key.\n\nReturns a promise that will be resolved to `[uuid, error]`\n\n`algorithm` can be one of:\n\n* `'RS256'`\n* `'RS384'`\n* `'RS512'`\n* `'PS256'`\n* `'PS384'`\n* `'PS512'`\n* `'ES256'`\n* `'ES384'`\n* `'ES512'`\n\n\n### setPlainPassword(password)\nHash the plain-password, and det the hashed-password that will be used to export and import the credentials.\n\nReturns the hashed password.\n\nThe plain password is not kept, and there is no way to get the plain password.\n\nIf no password is set, the empty string is used.\n\n### getHashedPassword()\nReturns the hashed-password.\n\n### setHashedPassword(hashedPassword)\nSets the hased-password\n\n### toText()\nExports the encrypted credentials to a string.\n\nReturns a promise that resolves to that string.\n\n### fromText()\nImports the encrypted credentials from a string.\n\nReturns a promise that resolves to undefined\n\n### toFile()\nSave the encrypted credentials to a file.\n\nReturns a promise that resolves to undefined\n\n### fromFile()\nOpens a FileOpen dialog, and import the encrypted credentials from the choosen file.\n\nReturns a promise that resolves to undefined\n\n### fetch(url, options)\nMakes a fetch to `safeApi.conf.server + url`\n\nYou can set `options` the same way you do with browser's `fetch`, but in `options.body` place no JSON but a javascript object.\n\nReturns a promise that resolves to `[response, error]`, where `response` is the payload, JSONparsed or null if some error has happend, in which case, `error` contains the error.\n\n### onUuidChange(callback)\nAdds a callback that will be called, with the UUID as first parameter, and a optional second parameter that could contain the reason of the UUID change, each time the uuid changes.\n\nReturns a function to remove the callback.\n\n### useUUID()\nReact hook that returns the UUID and refresh the component each time the UUID changes\n\n### logout()\nRemove locally the credentials, calls the `onUuidChange`'s callbaks and the `useUUID`'s hooks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhacknlove%2Fsafeapi-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhacknlove%2Fsafeapi-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhacknlove%2Fsafeapi-client/lists"}