@3sixty/api-tenant-processor 0.0.0-stage → 0.20.0-next.1

package/dist/types/tenantRoutes.d.ts

@@ -0,0 +1,78 @@
+import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type ITag } from "@3sixty/api-models";
+import type { ITenantCreateRequest } from "./models/api/ITenantCreateRequest.js";
+import type { ITenantGetByApiKeyRequest } from "./models/api/ITenantGetByApiKeyRequest.js";
+import type { ITenantGetByIdRequest } from "./models/api/ITenantGetByIdRequest.js";
+import type { ITenantGetByPublicOriginRequest } from "./models/api/ITenantGetByPublicOriginRequest.js";
+import type { ITenantGetResponse } from "./models/api/ITenantGetResponse.js";
+import type { ITenantListRequest } from "./models/api/ITenantListRequest.js";
+import type { ITenantListResponse } from "./models/api/ITenantListResponse.js";
+import type { ITenantRemoveRequest } from "./models/api/ITenantRemoveRequest.js";
+import type { ITenantUpdateRequest } from "./models/api/ITenantUpdateRequest.js";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsTenants: ITag[];
+/**
+ * The REST routes for tenant management.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesTenants(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Get the list of tenants.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantList(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantListRequest): Promise<ITenantListResponse>;
+/**
+ * Get the tenant by id.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantById(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantGetByIdRequest): Promise<ITenantGetResponse>;
+/**
+ * Get the tenant by api key.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantByApiKey(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantGetByApiKeyRequest): Promise<ITenantGetResponse>;
+/**
+ * Get the tenant by public origin.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantByPublicOrigin(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantGetByPublicOriginRequest): Promise<ITenantGetResponse>;
+/**
+ * Remove the tenant by id.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantRemoveRequest): Promise<INoContentResponse>;
+/**
+ * Create the tenant.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @param baseRouteName The base route name for the tenant.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantCreateRequest, baseRouteName: string): Promise<ICreatedResponse>;
+/**
+ * Update the tenant.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function tenantUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: ITenantUpdateRequest): Promise<INoContentResponse>;

package/dist/types/utils/tenantIdHelper.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Helper class for tenant id related operations.
+ */
+export declare class TenantIdHelper {
+    /**
+     * Generates a new tenant ID.
+     * @returns A new tenant ID.
+     */
+    static generateTenantId(): string;
+    /**
+     * Generates a new API Key.
+     * @returns A new API Key.
+     */
+    static generateApiKey(): string;
+}

package/docs/changelog.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [0.20.0-next.1](https://github.com/3sixtyglobal/api/compare/api-tenant-processor-v0.20.0-next.0...api-tenant-processor-v0.20.0-next.1) (2026-10-23)
+
+
+### Features
+
+* authorization ([#51](https://github.com/3sixtyglobal/api/issues/51)) ([023ef94](https://github.com/3sixtyglobal/api/commit/023ef94925114e88522cbe6f703d9b05a202bc6d))
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([91b1822](https://github.com/3sixtyglobal/api/commit/91b1822dba38f70692087ad4643572531d6634dc))
+* updated ts compile ([d9a5c86](https://github.com/3sixtyglobal/api/commit/d9a5c86ec7dd1faf3045b5cd1e0d38a4b331313d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @3sixty/api-models bumped from 0.20.0-next.0 to 0.20.0-next.1

package/docs/examples.md

@@ -0,0 +1,81 @@
+# Tenant Processor Examples
+
+These snippets show tenant lifecycle management and request context routing for multi-tenant deployments.
+
+## TenantAdminService
+
+```typescript
+import { TenantAdminService } from '@3sixty/api-tenant-processor';
+
+const tenantAdmin = new TenantAdminService();
+
+console.log(tenantAdmin.className()); // TenantAdminService
+
+const createdTenantId = await tenantAdmin.create({
+  label: 'North Region',
+  apiKey: '0123456789abcdef0123456789abcdef',
+  publicOrigin: 'https://north.example.org'
+});
+
+await tenantAdmin.update({
+  id: createdTenantId,
+  label: 'North Region EU'
+});
+
+const byKey = await tenantAdmin.getByApiKey('0123456789abcdef0123456789abcdef');
+console.log(byKey.id.length); // 32
+```
+
+```typescript
+import { TenantAdminService } from '@3sixty/api-tenant-processor';
+
+const tenantAdmin = new TenantAdminService();
+
+const byId = await tenantAdmin.get('0123456789abcdef0123456789abcdef');
+const byOrigin = await tenantAdmin.getByPublicOrigin('https://north.example.org');
+const page = await tenantAdmin.query({ isNodeTenant: false }, '', 10);
+
+await tenantAdmin.remove(byId.id);
+
+console.log(byOrigin.label); // North Region EU
+console.log(page.tenants.length); // 1
+```
+
+## TenantIdContextIdHandler
+
+```typescript
+import { TenantIdContextIdHandler } from '@3sixty/api-tenant-processor';
+
+const handler = new TenantIdContextIdHandler();
+
+console.log(handler.className()); // TenantIdContextIdHandler
+console.log(handler.short('0123456789abcdef0123456789abcdef')); // ASNFZ4mrze8BI0VniavN7w
+
+handler.guard('0123456789abcdef0123456789abcdef');
+```
+
+## TenantProcessor
+
+```typescript
+import { TenantProcessor } from '@3sixty/api-tenant-processor';
+
+const tenantProcessor = new TenantProcessor();
+
+console.log(tenantProcessor.className()); // TenantProcessor
+
+const request = {
+  method: 'get',
+  url: '/info',
+  headers: {
+    'x-api-key': '0123456789abcdef0123456789abcdef'
+  },
+  query: {}
+};
+
+const response = {};
+const contextIds = {};
+const processorState: { [id: string]: unknown } = {};
+
+await tenantProcessor.pre(request, response, { skipTenant: false }, contextIds, processorState);
+console.log(typeof contextIds.tenant); // string
+```

package/docs/reference/classes/SingleTenantProcessor.md

@@ -0,0 +1,130 @@
+# Class: SingleTenantProcessor
+
+Injects the single-tenant organization ID into every request context and validates any organization query parameter.
+
+## Implements
+
+- `IBaseRouteProcessor`
+
+## Constructors
+
+### Constructor
+
+> **new SingleTenantProcessor**(`options?`): `SingleTenantProcessor`
+
+Create a new instance of SingleTenantProcessor.
+
+#### Parameters
+
+##### options?
+
+[`ISingleTenantProcessorConstructorOptions`](../interfaces/ISingleTenantProcessorConstructorOptions.md)
+
+Options for the processor.
+
+#### Returns
+
+`SingleTenantProcessor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IBaseRouteProcessor.className`
+
+***
+
+### start() {#start}
+
+> **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+Cache the node organization ID from the engine context so it can be injected into each
+per-request context without requiring a separate ContextIdProcessor for Organization.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the node organization ID has been cached.
+
+#### Implementation of
+
+`IBaseRouteProcessor.start`
+
+***
+
+### pre() {#pre}
+
+> **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\>
+
+Pre process the REST request for the specified route.
+
+#### Parameters
+
+##### request
+
+`IHttpServerRequest`
+
+The incoming request.
+
+##### response
+
+`IHttpResponse`
+
+The outgoing response.
+
+##### route
+
+`IBaseRoute` \| `undefined`
+
+The route to process.
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs of the request.
+
+##### processorState
+
+\{\[`id`: `string`\]: `unknown`; \}
+
+The state handed through the processors.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the organization ID has been injected and any query parameter validated.
+
+#### Implementation of
+
+`IBaseRouteProcessor.pre`

package/docs/reference/classes/Tenant.md

@@ -0,0 +1,77 @@
+# Class: Tenant
+
+Class defining the storage for node tenants.
+
+## Constructors
+
+### Constructor
+
+> **new Tenant**(): `Tenant`
+
+#### Returns
+
+`Tenant`
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The unique identifier for the tenant.
+
+***
+
+### apiKey {#apikey}
+
+> **apiKey**: `string`
+
+The api key for the tenant.
+
+***
+
+### label {#label}
+
+> **label**: `string`
+
+The label of the tenant.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+The date the tenant was created.
+
+***
+
+### dateModified {#datemodified}
+
+> **dateModified**: `string`
+
+The date the tenant was modified.
+
+***
+
+### publicOrigin? {#publicorigin}
+
+> `optional` **publicOrigin?**: `string`
+
+The origin available to the public for accessing the API.
+
+***
+
+### organizationId {#organizationid}
+
+> **organizationId**: `string`
+
+The organization id for the tenant.
+
+***
+
+### organizationIdLegacy? {#organizationidlegacy}
+
+> `optional` **organizationIdLegacy?**: `string`[]
+
+Optional list of organization aliases that can be used for legacy lookups, indexed format.