@astralbeam/sdk 0.6.0 → 0.7.0

package/dist/server.d.ts

@@ -1,26 +1,30 @@
-import * as Schema from "effect/Schema";
-
 //#region src/server/index.d.ts
 declare const CHAT_AUTH_TOKEN_AUDIENCE = "astralbeam";
 declare const CHAT_AUTH_TOKEN_TYPE = "astralbeam+jwt";
 declare const CHAT_AUTH_TOKEN_VERSION = 4;
 declare const CHAT_AUTH_TOKEN_LIFETIME_SECONDS = 300;
 declare const CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS = 600;
-declare const TenantSchema: Schema.Struct<{
-  readonly id: Schema.String;
-  readonly name: Schema.optional<Schema.String>;
-  readonly metadata: Schema.optional<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
-}>;
-declare const TenantUserSchema: Schema.Struct<{
-  readonly id: Schema.String;
-  readonly name: Schema.optional<Schema.String>;
-  readonly admin: Schema.optional<Schema.Boolean>;
-  readonly metadata: Schema.optional<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
-}>;
+/** A JSON value, which is all a `metadata` object may hold: the token carries it verbatim. */
+type JsonValue = string | number | boolean | null | readonly JsonValue[] | {
+  readonly [key: string]: JsonValue;
+};
+/** A `metadata` object: caller-owned keys, preserved verbatim in the token's claims. */
+type JsonMetadata = {
+  readonly [key: string]: JsonValue;
+};
 /** Tenant identity from the Organization's application, including JSON metadata. */
-type Tenant = typeof TenantSchema.Type;
+interface Tenant {
+  readonly id: string;
+  readonly name?: string | undefined;
+  readonly metadata?: JsonMetadata | undefined;
+}
 /** User of an Organization's Tenant who interacts with AstralBeam. */
-type TenantUser = typeof TenantUserSchema.Type;
+interface TenantUser {
+  readonly id: string;
+  readonly name?: string | undefined;
+  readonly admin?: boolean | undefined;
+  readonly metadata?: JsonMetadata | undefined;
+}
 interface CreateChatAuthTokenOptions<TTenantUser extends TenantUser = TenantUser, TTenant extends Tenant = Tenant> {
   readonly apiKey: string;
   readonly user: TTenantUser;
@@ -35,4 +39,4 @@ declare function createChatAuthToken<TTenantUser extends TenantUser = TenantUser
   expiresInSeconds
 }: CreateChatAuthTokenOptions<TTenantUser, TTenant>): Promise<string>;
 //#endregion
-export { CHAT_AUTH_TOKEN_AUDIENCE, CHAT_AUTH_TOKEN_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_TYPE, CHAT_AUTH_TOKEN_VERSION, CreateChatAuthTokenOptions, Tenant, TenantSchema, TenantUser, TenantUserSchema, createChatAuthToken };
+export { CHAT_AUTH_TOKEN_AUDIENCE, CHAT_AUTH_TOKEN_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_TYPE, CHAT_AUTH_TOKEN_VERSION, CreateChatAuthTokenOptions, JsonMetadata, JsonValue, Tenant, TenantUser, createChatAuthToken };

package/dist/server.js

@@ -1,4 +1,3 @@
-import * as Schema from "effect/Schema";
 //#region node_modules/.deno/jose@6.2.9/node_modules/jose/dist/webapi/lib/buffer_utils.js
 const encoder = new TextEncoder();
 const decoder = new TextDecoder();
@@ -645,43 +644,22 @@ const CHAT_AUTH_TOKEN_LIFETIME_SECONDS = 300;
 const CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS = 600;
 const CHAT_AUTH_TOKEN_MAX_BYTES = 16384;
 const IDENTITY_MAX_BYTES = 8192;
+const EXTERNAL_ID_MAX_LENGTH = 255;
+const API_KEY_PATTERN = /^key_[0-9a-z-]{1,63}_[0-9a-z-]{1,63}_abo_[A-Za-z]{64}$/;
+const TENANT_FIELDS = [
+	"id",
+	"name",
+	"metadata"
+];
+const TENANT_USER_FIELDS = [
+	"id",
+	"name",
+	"admin",
+	"metadata"
+];
 const textEncoder = new TextEncoder();
-const SlugSchema = Schema.String.pipe(Schema.check(Schema.isPattern(/^[0-9a-z-]{1,63}$/)));
-const ApiKeySecretSchema = Schema.String.pipe(Schema.check(Schema.isPattern(/^abo_[A-Za-z]{64}$/)));
-const ApiKeySchema = Schema.TemplateLiteral([
-	"key_",
-	SlugSchema,
-	"_",
-	SlugSchema,
-	"_",
-	ApiKeySecretSchema
-]);
-const isApiKey = Schema.is(ApiKeySchema);
-const MetadataSchema = Schema.JsonObject.annotate({ message: "metadata must be a JSON object" });
-const TenantExternalIdSchema = Schema.String.pipe(Schema.check(Schema.makeFilter((value) => value.length >= 1 && value.length <= 255, { message: "tenant.id must be a 1-255 character string" })));
-const TenantUserExternalIdSchema = Schema.String.pipe(Schema.check(Schema.makeFilter((value) => value.length >= 1 && value.length <= 255, { message: "user.id must be a 1-255 character string" })));
-const TenantSchema = Schema.Struct({
-	id: TenantExternalIdSchema,
-	name: Schema.optional(Schema.String),
-	metadata: Schema.optional(MetadataSchema)
-});
-const TenantUserSchema = Schema.Struct({
-	id: TenantUserExternalIdSchema,
-	name: Schema.optional(Schema.String),
-	admin: Schema.optional(Schema.Boolean),
-	metadata: Schema.optional(MetadataSchema)
-});
-const IdentitySchema = Schema.Struct({
-	user: TenantUserSchema,
-	tenant: TenantSchema
-}).pipe(Schema.check(Schema.makeFilter((value) => textEncoder.encode(JSON.stringify(value)).byteLength <= IDENTITY_MAX_BYTES, { message: `user and tenant must not exceed ${IDENTITY_MAX_BYTES} bytes` })));
-const decodeIdentity = Schema.decodeUnknownSync(IdentitySchema, {
-	errors: "all",
-	onExcessProperty: "error",
-	reportInput: false
-});
 function parseApiKey(apiKey) {
-	if (!isApiKey(apiKey)) throw new Error("apiKey must match key_<organization>_<key>_abo_<secret>");
+	if (!API_KEY_PATTERN.test(apiKey)) throw new Error("apiKey must match key_<organization>_<key>_abo_<secret>");
 	const separator = apiKey.lastIndexOf("_abo_");
 	const keyId = apiKey.slice(0, separator);
 	const keySecret = apiKey.slice(separator + 1);
@@ -691,11 +669,36 @@ function parseApiKey(apiKey) {
 		keySecret
 	};
 }
+function isPlainObject(value) {
+	if (typeof value !== "object" || value === null) return false;
+	const prototype = Object.getPrototypeOf(value);
+	return prototype === Object.prototype || prototype === null;
+}
+function isJsonValue(value) {
+	if (value === null || typeof value === "string" || typeof value === "boolean") return true;
+	if (typeof value === "number") return Number.isFinite(value);
+	if (Array.isArray(value)) return value.every(isJsonValue);
+	return isPlainObject(value) && Object.values(value).every(isJsonValue);
+}
+function validateIdentity(label, value, isUser) {
+	if (!isPlainObject(value)) throw new Error(`${label} must be an object`);
+	const fields = isUser ? TENANT_USER_FIELDS : TENANT_FIELDS;
+	for (const key of Object.keys(value)) if (!fields.includes(key)) throw new Error(`${label} has an unknown field "${key}"`);
+	const { id, name, admin, metadata } = value;
+	if (typeof id !== "string" || id.length < 1 || id.length > EXTERNAL_ID_MAX_LENGTH) throw new Error(`${label}.id must be a 1-${EXTERNAL_ID_MAX_LENGTH} character string`);
+	if (name !== void 0 && typeof name !== "string") throw new Error(`${label}.name must be a string`);
+	if (isUser && admin !== void 0 && typeof admin !== "boolean") throw new Error(`${label}.admin must be a boolean`);
+	if (metadata !== void 0 && !(isPlainObject(metadata) && isJsonValue(metadata))) throw new Error(`${label}.metadata must be a JSON object`);
+}
 function validatedIdentity(user, tenant) {
-	return JSON.parse(JSON.stringify(decodeIdentity({
+	validateIdentity("user", user, true);
+	validateIdentity("tenant", tenant, false);
+	const json = JSON.stringify({
 		user,
 		tenant
-	})));
+	});
+	if (textEncoder.encode(json).byteLength > IDENTITY_MAX_BYTES) throw new Error(`user and tenant must not exceed ${IDENTITY_MAX_BYTES} bytes`);
+	return JSON.parse(json);
 }
 async function signingKey(secret) {
 	const digest = await crypto.subtle.digest("SHA-256", textEncoder.encode(secret));
@@ -720,4 +723,4 @@ async function createChatAuthToken({ apiKey, user, tenant, expiresInSeconds = 30
 	return token;
 }
 //#endregion
-export { CHAT_AUTH_TOKEN_AUDIENCE, CHAT_AUTH_TOKEN_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_TYPE, CHAT_AUTH_TOKEN_VERSION, TenantSchema, TenantUserSchema, createChatAuthToken };
+export { CHAT_AUTH_TOKEN_AUDIENCE, CHAT_AUTH_TOKEN_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_MAX_LIFETIME_SECONDS, CHAT_AUTH_TOKEN_TYPE, CHAT_AUTH_TOKEN_VERSION, createChatAuthToken };