@3sixty/api-auth-entity-storage-rest-client 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/IEntityStorageAuthenticationRestClientConstructorOptions.md

@@ -0,0 +1,153 @@
+# Interface: IEntityStorageAuthenticationRestClientConstructorOptions
+
+Options for the Entity Storage Authentication REST client constructor.
+
+## Extends
+
+- `IBaseRestClientConfig`
+
+## Properties
+
+### cookieName? {#cookiename}
+
+> `optional` **cookieName?**: `string`
+
+The name of the cookie to use for storing the auth token.
+
+#### Default
+
+```ts
+access_token
+```
+
+***
+
+### endpoint {#endpoint}
+
+> **endpoint**: `string`
+
+The endpoint where the api is hosted.
+
+#### Inherited from
+
+`IBaseRestClientConfig.endpoint`
+
+***
+
+### pathPrefix? {#pathprefix}
+
+> `optional` **pathPrefix?**: `string`
+
+The prefix to the routes.
+
+#### Inherited from
+
+`IBaseRestClientConfig.pathPrefix`
+
+***
+
+### headers? {#headers}
+
+> `optional` **headers?**: `IHttpHeaders`
+
+The headers to include in requests.
+
+#### Inherited from
+
+`IBaseRestClientConfig.headers`
+
+***
+
+### timeout? {#timeout}
+
+> `optional` **timeout?**: `number`
+
+Timeout for requests in ms.
+
+#### Inherited from
+
+`IBaseRestClientConfig.timeout`
+
+***
+
+### includeCredentials? {#includecredentials}
+
+> `optional` **includeCredentials?**: `boolean`
+
+Include credentials in the request, defaults to true.
+
+#### Inherited from
+
+`IBaseRestClientConfig.includeCredentials`
+
+***
+
+### processorTypes? {#processortypes}
+
+> `optional` **processorTypes?**: `string`[]
+
+The types of the processors to run around each request, resolved from the `RestClientProcessorFactory`.
+
+#### Inherited from
+
+`IBaseRestClientConfig.processorTypes`
+
+***
+
+### customHeaders? {#customheaders}
+
+> `optional` **customHeaders?**: () => `Promise`\<`IHttpHeaders`\>
+
+Hook to provide headers asynchronously.
+
+#### Returns
+
+`Promise`\<`IHttpHeaders`\>
+
+A promise that resolves to the headers.
+
+#### Inherited from
+
+`IBaseRestClientConfig.customHeaders`
+
+***
+
+### customAuthHeader? {#customauthheader}
+
+> `optional` **customAuthHeader?**: () => `Promise`\<`string`\>
+
+Hook to provide an authorization header value asynchronously.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+A promise that resolves to the authorization header value.
+
+#### Inherited from
+
+`IBaseRestClientConfig.customAuthHeader`
+
+***
+
+### onAuthFailure? {#onauthfailure}
+
+> `optional` **onAuthFailure?**: (`err`) => `Promise`\<`void`\>
+
+Hook to handle authorization failures asynchronously.
+
+#### Parameters
+
+##### err
+
+`IError`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the auth failure handling is complete.
+
+#### Inherited from
+
+`IBaseRestClientConfig.onAuthFailure`

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,6 +1,55 @@
 {
-  "name": "@3sixty/api-auth-entity-storage-rest-client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/api-auth-entity-storage-rest-client",
+	"version": "0.20.0-next.0",
+	"description": "REST clients for authentication and admin operations against entity storage endpoints.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/api.git",
+		"directory": "packages/api-auth-entity-storage-rest-client"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-auth-entity-storage-models": "0.20.0-next.0",
+		"@3sixty/api-core": "0.20.0-next.0",
+		"@3sixty/api-models": "0.20.0-next.0",
+		"@3sixty/core": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/web": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		}
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"api",
+		"entity",
+		"storage",
+		"persistence",
+		"database"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/api/issues"
+	},
+	"homepage": "https://3sixty.global"
+}