@compassdigital/sdk.typescript 4.765.0 → 4.767.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.765.0",
+	"version": "4.767.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -1487,6 +1487,16 @@ import {
 	PutAuthOauthClientResponse,
 	GetAuthOauthClientResponse,
 	DeleteAuthOauthClientResponse,
+	GetAuthOpenidConfigurationResponse,
+	PostAuthOidcRegisterBody,
+	PostAuthOidcRegisterResponse,
+	GetAuthAuthorizeQuery,
+	GetAuthAuthorizeResponse,
+	GetAuthAuthorizeRequestResponse,
+	PostAuthAuthorizeLoginBody,
+	PostAuthAuthorizeLoginResponse,
+	PostAuthAuthorizeSsoBody,
+	PostAuthAuthorizeSsoResponse,
 } from './interface/auth';
 
 import {
@@ -17225,6 +17235,117 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /auth/.well-known/openid-configuration - OpenID Provider metadata (RFC 8414 discovery document).
+	 *
+	 * @param options - additional request options
+	 */
+	get_auth_openid_configuration(
+		options?: RequestOptions,
+	): ResponsePromise<GetAuthOpenidConfigurationResponse> {
+		return this.request(
+			'auth',
+			'/auth/.well-known/openid-configuration',
+			'GET',
+			`/auth/.well-known/openid-configuration`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /auth/oidc/register - RFC 7591 dynamic client registration for public (PKCE-only) clients.
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_auth_oidc_register(
+		body: PostAuthOidcRegisterBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostAuthOidcRegisterResponse> {
+		return this.request(
+			'auth',
+			'/auth/oidc/register',
+			'POST',
+			`/auth/oidc/register`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /auth/authorize - OAuth 2.1 authorization endpoint. Stores the request and redirects to the login page.
+	 *
+	 * @param options - additional request options
+	 */
+	get_auth_authorize(
+		options?: {
+			query?: GetAuthAuthorizeQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetAuthAuthorizeResponse> {
+		return this.request('auth', '/auth/authorize', 'GET', `/auth/authorize`, null, options);
+	}
+
+	/**
+	 * GET /auth/authorize/request/{request_id} - What the login page needs to render a pending authorization request.
+	 *
+	 * @param request_id
+	 * @param options - additional request options
+	 */
+	get_auth_authorize_request(
+		request_id: string,
+		options?: RequestOptions,
+	): ResponsePromise<GetAuthAuthorizeRequestResponse> {
+		return this.request(
+			'auth',
+			'/auth/authorize/request/{request_id}',
+			'GET',
+			`/auth/authorize/request/${request_id}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /auth/authorize/login - Password login for a pending authorization request.
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_auth_authorize_login(
+		body: PostAuthAuthorizeLoginBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostAuthAuthorizeLoginResponse> {
+		return this.request(
+			'auth',
+			'/auth/authorize/login',
+			'POST',
+			`/auth/authorize/login`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /auth/authorize/sso - SSO login for a pending authorization request, using the secure exchange token minted by POST /auth/sso/exchange.
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_auth_authorize_sso(
+		body: PostAuthAuthorizeSsoBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostAuthAuthorizeSsoResponse> {
+		return this.request(
+			'auth',
+			'/auth/authorize/sso',
+			'POST',
+			`/auth/authorize/sso`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /review - Get reviews by taxonomy
 	 *

package/src/interface/auth.ts

@@ -214,6 +214,14 @@ export interface TokenRequestDTO {
 	subject_token?: string;
 	subject_token_type?: string;
 	requested_token_type?: string;
+	// authorization_code grant: the single-use code.
+	code?: string;
+	// authorization_code grant: the PKCE code_verifier.
+	code_verifier?: string;
+	// authorization_code grant: must match the authorization request.
+	redirect_uri?: string;
+	// refresh_token grant: the refresh token to rotate.
+	refresh_token?: string;
 }
 
 export interface TokenResponseDTO {
@@ -223,6 +231,16 @@ export interface TokenResponseDTO {
 	expires_in: number;
 	// Only present on the token_exchange grant, per RFC 8693 §2.2.1.
 	issued_token_type?: string;
+	// Only present on the authorization_code and refresh_token grants. Rotated on every refresh.
+	refresh_token?: string;
+	// Space-delimited scopes granted, echoed back on the authorization_code and refresh_token grants.
+	scope?: string;
+}
+
+export interface OAuthErrorResponseDTO {
+	// OAuth error code, e.g. invalid_grant.
+	error: string;
+	error_description: string;
 }
 
 export interface OAuthClientCreateRequestDTO {
@@ -259,6 +277,64 @@ export interface OAuthClientListResponseDTO {
 	createdAt: string;
 }
 
+export interface OpenIdConfigurationResponseDTO {
+	issuer: string;
+	authorization_endpoint: string;
+	token_endpoint: string;
+	registration_endpoint: string;
+	response_types_supported: string[];
+	grant_types_supported: string[];
+	code_challenge_methods_supported: string[];
+	token_endpoint_auth_methods_supported: string[];
+	scopes_supported: string[];
+}
+
+export interface OidcRegisterRequestDTO {
+	redirect_uris: string[];
+	client_name?: string;
+	grant_types?: string[];
+	token_endpoint_auth_method?: 'none';
+	// Space-delimited scope string.
+	scope?: string;
+}
+
+export interface OidcRegisterResponseDTO {
+	client_id: string;
+	// Epoch seconds.
+	client_id_issued_at: number;
+	client_name?: string;
+	redirect_uris: string[];
+	grant_types: string[];
+	response_types: string[];
+	token_endpoint_auth_method: 'none';
+	// Space-delimited scope string.
+	scope: string;
+}
+
+export interface AuthorizeRequestResponseDTO {
+	// Display name of the OAuth client requesting access.
+	client_name: string;
+	scopes: string[];
+	realm: string;
+}
+
+export interface AuthorizeLoginRequestDTO {
+	request_id: string;
+	email: string;
+	password: string;
+}
+
+export interface AuthorizeRedirectResponseDTO {
+	// Where the login page must send the browser next: the client's redirect_uri with `code` and `state` appended.
+	redirect_to: string;
+}
+
+export interface AuthorizeSsoRequestDTO {
+	request_id: string;
+	// Secure exchange token minted by POST /auth/sso/exchange.
+	token: string;
+}
+
 // POST /auth/flow - Determines the authentication flow for a user based on their email address
 
 export type PostAuthFlowBody = SSOFlowRequestDTO;
@@ -437,3 +513,50 @@ export interface DeleteAuthOauthClientPath {
 }
 
 export type DeleteAuthOauthClientResponse = OAuthClientResponseDTO;
+
+// GET /auth/.well-known/openid-configuration - OpenID Provider metadata (RFC 8414 discovery document).
+
+export type GetAuthOpenidConfigurationResponse = OpenIdConfigurationResponseDTO;
+
+// POST /auth/oidc/register - RFC 7591 dynamic client registration for public (PKCE-only) clients.
+
+export type PostAuthOidcRegisterBody = OidcRegisterRequestDTO;
+
+export type PostAuthOidcRegisterResponse = OidcRegisterResponseDTO;
+
+// GET /auth/authorize - OAuth 2.1 authorization endpoint. Stores the request and redirects to the login page.
+
+export interface GetAuthAuthorizeQuery {
+	client_id?: string;
+	redirect_uri?: string;
+	response_type?: 'code';
+	// Space-delimited scope string.
+	scope?: string;
+	state?: string;
+	code_challenge?: string;
+	code_challenge_method?: 'S256';
+	// RFC 8707 resource indicator.
+	resource?: string;
+}
+
+export type GetAuthAuthorizeResponse = {};
+
+// GET /auth/authorize/request/{request_id} - What the login page needs to render a pending authorization request.
+
+export interface GetAuthAuthorizeRequestPath {
+	request_id: string;
+}
+
+export type GetAuthAuthorizeRequestResponse = AuthorizeRequestResponseDTO;
+
+// POST /auth/authorize/login - Password login for a pending authorization request.
+
+export type PostAuthAuthorizeLoginBody = AuthorizeLoginRequestDTO;
+
+export type PostAuthAuthorizeLoginResponse = AuthorizeRedirectResponseDTO;
+
+// POST /auth/authorize/sso - SSO login for a pending authorization request, using the secure exchange token minted by POST /auth/sso/exchange.
+
+export type PostAuthAuthorizeSsoBody = AuthorizeSsoRequestDTO;
+
+export type PostAuthAuthorizeSsoResponse = AuthorizeRedirectResponseDTO;

package/src/interface/menu.ts

@@ -2096,6 +2096,13 @@ export interface ReorderMenuItemDTO {
 	[index: string]: any;
 }
 
+export interface BulkGeneratedBarcodeDTO {
+	item_id: string;
+	barcode: string;
+	generated: boolean;
+	[index: string]: any;
+}
+
 export interface DraftModifierGroupEntityDTO {
 	parent?: DraftModifierGroupDTO;
 	children?: DraftModifierGroupDTO[];
@@ -8743,7 +8750,10 @@ export interface PostMenuV4BrandGenerateBarcodesBody {
 }
 
 export interface PostMenuV4BrandGenerateBarcodesResponse {
-	generated?: number;
+	generated: number;
+	items: BulkGeneratedBarcodeDTO[];
+	not_found: string[];
+	[index: string]: any;
 }
 
 export interface PostMenuV4BrandGenerateBarcodesRequest