sst 3.0.14 → 3.0.16

package/dist/auth/session.js

@@ -6,7 +6,7 @@ export function createSessionBuilder() {
         async verify(token) {
             const auth = Object.values(Resource).find((value) => value.publicKey);
             if (!auth) {
-                throw new Error("No auth resource found");
+                throw new Error("No auth resource found. Make sure to link the auth resource to this function.");
             }
             const publicKey = auth.publicKey;
             const result = await jwtVerify(token, await importSPKI(publicKey, "RS512"));

package/dist/event/index.d.ts

@@ -0,0 +1,74 @@
+import { ZodObject, ZodSchema, z } from "zod";
+type Event = {
+    type: string;
+    $output: any;
+    $metadata: any;
+    $payload: any;
+};
+export declare function EventClient<MetadataFunction extends () => any, Validator extends (schema: any) => (input: any) => any, MetadataSchema extends Parameters<Validator>[0] | undefined>(input: {
+    metadata?: MetadataSchema;
+    metadataFn?: MetadataFunction;
+    validator: Validator;
+}): {
+    <Type extends string, Schema extends Parameters<Validator>[0]>(type: Type, schema: Schema): {
+        create: undefined extends MetadataSchema ? (properties: inferParser<Schema>["in"]) => {
+            type: Type;
+            properties: inferParser<Schema>["out"];
+            metadata: ReturnType<MetadataFunction>;
+        } : (properties: inferParser<Schema>["in"], metadata: inferParser<MetadataSchema>["in"]) => {
+            type: Type;
+            properties: inferParser<Schema>["out"];
+            metadata: ReturnType<MetadataFunction>;
+        };
+        type: Type;
+        $input: inferParser<Schema>["in"];
+        $output: inferParser<Schema>["out"];
+        $payload: {
+            type: Type;
+            properties: inferParser<Schema>["out"];
+            metadata: ReturnType<MetadataFunction>;
+        };
+        $metadata: ReturnType<MetadataFunction>;
+    };
+    coerce<Events extends Event>(_events: Events | Events[], raw: any): { [K in Events["type"]]: Extract<Events, {
+        type: K;
+    }>["$payload"]; }[Events["type"]];
+};
+export declare function ZodValidator<Schema extends ZodSchema>(schema: Schema): (input: z.input<Schema>) => z.output<Schema>;
+export type ParserZodEsque<TInput, TParsedInput> = {
+    _input: TInput;
+    _output: TParsedInput;
+};
+export type ParserValibotEsque<TInput, TParsedInput> = {
+    _types?: {
+        input: TInput;
+        output: TParsedInput;
+    };
+};
+export type ParserMyZodEsque<TInput> = {
+    parse: (input: any) => TInput;
+};
+export type ParserSuperstructEsque<TInput> = {
+    create: (input: unknown) => TInput;
+};
+export type ParserCustomValidatorEsque<TInput> = (input: unknown) => Promise<TInput> | TInput;
+export type ParserYupEsque<TInput> = {
+    validateSync: (input: unknown) => TInput;
+};
+export type ParserScaleEsque<TInput> = {
+    assert(value: unknown): asserts value is TInput;
+};
+export type ParserWithoutInput<TInput> = ParserCustomValidatorEsque<TInput> | ParserMyZodEsque<TInput> | ParserScaleEsque<TInput> | ParserSuperstructEsque<TInput> | ParserYupEsque<TInput>;
+export type ParserWithInputOutput<TInput, TParsedInput> = ParserZodEsque<TInput, TParsedInput> | ParserValibotEsque<TInput, TParsedInput>;
+export type Parser = ParserWithInputOutput<any, any> | ParserWithoutInput<any>;
+export type inferParser<TParser extends Parser> = TParser extends ParserWithInputOutput<infer $TIn, infer $TOut> ? {
+    in: $TIn;
+    out: $TOut;
+} : TParser extends ParserWithoutInput<infer $InOut> ? {
+    in: $InOut;
+    out: $InOut;
+} : never;
+export type inferEvent<T extends {
+    shape: ZodObject<any>;
+}> = z.infer<T["shape"]>;
+export {};

package/dist/event/index.js

@@ -0,0 +1,38 @@
+export function EventClient(input) {
+    const validator = input.validator;
+    const metadataValidator = input.metadata ? validator(input.metadata) : null;
+    const fn = function event(type, schema) {
+        const validate = validator(schema);
+        async function create(properties, metadata) {
+            if (metadataValidator) {
+                metadata = metadataValidator(metadata);
+            }
+            if (input.metadataFn) {
+                metadata = input.metadataFn();
+            }
+            properties = validate(properties);
+            return {
+                type,
+                properties,
+                metadata,
+            };
+        }
+        return {
+            create: create,
+            type,
+            $input: {},
+            $output: {},
+            $payload: {},
+            $metadata: {},
+        };
+    };
+    fn.coerce = (_events, raw) => {
+        return raw;
+    };
+    return fn;
+}
+export function ZodValidator(schema) {
+    return (input) => {
+        return schema.parse(input);
+    };
+}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+export * from "./realtime/index.js";
 export * from "./resource.js";
-export * from "./vector-client.js";
+export * from "./vector/index.js";

package/dist/index.js

@@ -1,2 +1,3 @@
+export * from "./realtime/index.js";
 export * from "./resource.js";
-export * from "./vector-client.js";
+export * from "./vector/index.js";

package/dist/realtime/index.d.ts

@@ -0,0 +1,59 @@
+import type { IoTCustomAuthorizerHandler } from "aws-lambda";
+export interface RealtimeAuthResult {
+    /**
+     * The topics the client can subscribe to.
+     * @example
+     * For example, this subscribes to specific topics.
+     * ```js
+     * {
+     *   subscribe: ["chat/room1", "chat/room2"]
+     * }
+     * ```
+     *
+     * And to subscribe to all topics under a specific prefix.
+     * ```js
+     * {
+     *   subscribe: ["chat/*"]
+     * }
+     * ```
+     */
+    subscribe?: string[];
+    /**
+     * The topics the client can publish to.
+     * @example
+     * For example, this publishes to specific topics.
+     * ```js
+     * {
+     *   publish: ["chat/room1", "chat/room2"]
+     * }
+     * ```
+     * And to publish to all topics under a specific prefix.
+     * ```js
+     * {
+     *   publish: ["chat/*"]
+     * }
+     * ```
+     */
+    publish?: string[];
+}
+/**
+ * Creates an authorization handler for the `Realtime` component, that validates
+ * the token and grants permissions for the topics the client can subscribe and publish to.
+ *
+ * @example
+ * ```js
+ * import { RealtimeAuthHandler, Resource } from "sst";
+ *
+ * export const handler = RealtimeAuthHandler(async (token) => {
+ *   // Validate the token
+ *   console.log(token);
+ *
+ *   // Return the topics to subscribe and publish
+ *   return {
+ *     subscribe: [`${Resource.App.name}/${Resource.App.stage}/chat/room1`],
+ *     publish: [`${Resource.App.name}/${Resource.App.stage}/chat/room1`],
+ *   };
+ * });
+ * ```
+ */
+export declare function RealtimeAuthHandler(input: (token: string) => Promise<RealtimeAuthResult>): IoTCustomAuthorizerHandler;

package/dist/realtime/index.js

@@ -0,0 +1,72 @@
+/**
+ * Creates an authorization handler for the `Realtime` component, that validates
+ * the token and grants permissions for the topics the client can subscribe and publish to.
+ *
+ * @example
+ * ```js
+ * import { RealtimeAuthHandler, Resource } from "sst";
+ *
+ * export const handler = RealtimeAuthHandler(async (token) => {
+ *   // Validate the token
+ *   console.log(token);
+ *
+ *   // Return the topics to subscribe and publish
+ *   return {
+ *     subscribe: [`${Resource.App.name}/${Resource.App.stage}/chat/room1`],
+ *     publish: [`${Resource.App.name}/${Resource.App.stage}/chat/room1`],
+ *   };
+ * });
+ * ```
+ */
+export function RealtimeAuthHandler(input) {
+    return async (evt, context) => {
+        const [, , , region, accountId] = context.invokedFunctionArn.split(":");
+        const token = Buffer.from(evt.protocolData.mqtt?.password ?? "", "base64").toString();
+        const ret = await input(token);
+        return {
+            isAuthenticated: true,
+            principalId: Date.now().toString(),
+            disconnectAfterInSeconds: 86400,
+            refreshAfterInSeconds: 300,
+            policyDocuments: [
+                {
+                    Version: "2012-10-17",
+                    Statement: [
+                        {
+                            Action: "iot:Connect",
+                            Effect: "Allow",
+                            Resource: "*",
+                        },
+                        ...(ret.subscribe
+                            ? [
+                                {
+                                    Action: "iot:Receive",
+                                    Effect: "Allow",
+                                    Resource: ret.subscribe.map((t) => `arn:aws:iot:${region}:${accountId}:topic/${t}`),
+                                },
+                            ]
+                            : []),
+                        ...(ret.subscribe
+                            ? [
+                                {
+                                    Action: "iot:Subscribe",
+                                    Effect: "Allow",
+                                    Resource: ret.subscribe.map((t) => `arn:aws:iot:${region}:${accountId}:topicfilter/${t}`),
+                                },
+                            ]
+                            : []),
+                        ...(ret.publish
+                            ? [
+                                {
+                                    Action: "iot:Publish",
+                                    Effect: "Allow",
+                                    Resource: ret.publish.map((t) => `arn:aws:iot:${region}:${accountId}:topic/${t}`),
+                                },
+                            ]
+                            : []),
+                    ],
+                },
+            ],
+        };
+    };
+}

package/dist/util/prettify.d.ts

@@ -0,0 +1,3 @@
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/util/prettify.js

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

package/dist/vector/index.d.ts

@@ -0,0 +1,193 @@
+import { Resource } from "../resource.js";
+export interface PutEvent {
+    /**
+     * The vector to store in the database.
+     * @example
+     * ```js
+     * {
+     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+     * }
+     * ```
+     */
+    vector: number[];
+    /**
+     * Metadata for the event in JSON format.
+     * This metadata will be used to filter when quering and removing vectors.
+     * @example
+     * ```js
+     * {
+     *   metadata: {
+     *     type: "movie",
+     *     id: "movie-123",
+     *     name: "Spiderman",
+     *   }
+     * }
+     * ```
+     */
+    metadata: Record<string, any>;
+}
+export interface QueryEvent {
+    /**
+     * The vector used to query the database.
+     * @example
+     * ```js
+     * {
+     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+     * }
+     * ```
+     */
+    vector: number[];
+    /**
+     * The metadata used to filter the vectors.
+     * Only vectors that match the provided fields will be returned.
+     * @example
+     * ```js
+     * {
+     *   include: {
+     *     type: "movie",
+     *     release: "2001",
+     *   }
+     * }
+     * ```
+     * This will match the vector with metadata:
+     * ```js
+     *  {
+     *    type: "movie",
+     *    name: "Spiderman",
+     *    release: "2001",
+     *  }
+     * ```
+     *
+     * But not the vector with metadata:
+     * ```js
+     *  {
+     *    type: "book",
+     *    name: "Spiderman",
+     *    release: "2001",
+     *  }
+     * ```
+     */
+    include: Record<string, any>;
+    /**
+     * Exclude vectors with metadata that match the provided fields.
+     * @example
+     * ```js
+     * {
+     *   include: {
+     *     type: "movie",
+     *     release: "2001",
+     *   },
+     *   exclude: {
+     *     name: "Spiderman",
+     *   }
+     * }
+     * ```
+     * This will match the vector with metadata:
+     * ```js
+     *  {
+     *    type: "movie",
+     *    name: "A Beautiful Mind",
+     *    release: "2001",
+     *  }
+     * ```
+     *
+     * But not the vector with metadata:
+     * ```js
+     *  {
+     *    type: "book",
+     *    name: "Spiderman",
+     *    release: "2001",
+     *  }
+     * ```
+     */
+    exclude?: Record<string, any>;
+    /**
+     * The threshold of similarity between the prompt and the queried vectors.
+     * Only vectors with a similarity score higher than the threshold will be returned.
+     * Expected value is between 0 and 1.
+     * - 0 means the prompt and the queried vectors are completely different.
+     * - 1 means the prompt and the queried vectors are identical.
+     * @default `0`
+     * @example
+     * ```js
+     * {
+     *   threshold: 0.5,
+     * }
+     * ```
+     */
+    threshold?: number;
+    /**
+     * The number of results to return.
+     * @default `10`
+     * @example
+     * ```js
+     * {
+     *   count: 10,
+     * }
+     * ```
+     */
+    count?: number;
+}
+export interface RemoveEvent {
+    /**
+     * The metadata used to filter the removal of vectors.
+     * Only vectors with metadata that match the provided fields will be removed.
+     * @example
+     * To remove vectors for movie with id "movie-123":
+     * ```js
+     * {
+     *   include: {
+     *     id: "movie-123",
+     *   }
+     * }
+     * ```
+     * To remove vectors for all movies:
+     * ```js
+     *  {
+     *   include: {
+     *    type: "movie",
+     *   }
+     *  }
+     * ```
+     */
+    include: Record<string, any>;
+}
+export interface QueryResponse {
+    /**
+     * Metadata for the event in JSON format that was provided when storing the vector.
+     */
+    metadata: Record<string, any>;
+    /**
+     * The similarity score between the prompt and the queried vector.
+     */
+    score: number;
+}
+export interface VectorClientResponse {
+    put: (event: PutEvent) => Promise<void>;
+    query: (event: QueryEvent) => Promise<QueryResponse>;
+    remove: (event: RemoveEvent) => Promise<void>;
+}
+/**
+ * Create a client to interact with the Vector database.
+ * @example
+ * ```js
+ * import { VectorClient } from "sst";
+ * const client = VectorClient("MyVectorDB");
+ *
+ * // Store a vector into the db
+ * await client.put({
+ *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+ *   metadata: { type: "movie", genre: "comedy" },
+ * });
+ *
+ * // Query vectors similar to the provided vector
+ * const result = await client.query({
+ *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+ *   include: { type: "movie" },
+ *   exclude: { genre: "thriller" },
+ * });
+ * ```
+ */
+export declare function VectorClient<T extends keyof {
+    [key in keyof Resource as "sst.aws.Vector" extends Resource[key]["type"] ? string extends key ? never : key : never]: Resource[key];
+}>(name: T): VectorClientResponse;

package/dist/vector/index.js

@@ -0,0 +1,62 @@
+import { LambdaClient, InvokeCommand, } from "@aws-sdk/client-lambda";
+import { Resource } from "../resource.js";
+const lambda = new LambdaClient();
+/**
+ * Create a client to interact with the Vector database.
+ * @example
+ * ```js
+ * import { VectorClient } from "sst";
+ * const client = VectorClient("MyVectorDB");
+ *
+ * // Store a vector into the db
+ * await client.put({
+ *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+ *   metadata: { type: "movie", genre: "comedy" },
+ * });
+ *
+ * // Query vectors similar to the provided vector
+ * const result = await client.query({
+ *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+ *   include: { type: "movie" },
+ *   exclude: { genre: "thriller" },
+ * });
+ * ```
+ */
+export function VectorClient(name) {
+    return {
+        put: async (event) => {
+            const ret = await lambda.send(new InvokeCommand({
+                // @ts-expect-error
+                FunctionName: Resource[name].putFunction,
+                Payload: JSON.stringify(event),
+            }));
+            parsePayload(ret, "Failed to store into the vector db");
+        },
+        query: async (event) => {
+            const ret = await lambda.send(new InvokeCommand({
+                // @ts-expect-error
+                FunctionName: Resource[name].queryFunction,
+                Payload: JSON.stringify(event),
+            }));
+            return parsePayload(ret, "Failed to query the vector db");
+        },
+        remove: async (event) => {
+            const ret = await lambda.send(new InvokeCommand({
+                // @ts-expect-error
+                FunctionName: Resource[name].removeFunction,
+                Payload: JSON.stringify(event),
+            }));
+            parsePayload(ret, "Failed to remove from the vector db");
+        },
+    };
+}
+function parsePayload(output, message) {
+    const payload = JSON.parse(Buffer.from(output.Payload).toString());
+    // Set cause to the payload so that it can be logged in CloudWatch
+    if (output.FunctionError) {
+        const e = new Error(message);
+        e.cause = payload;
+        throw e;
+    }
+    return payload;
+}

package/package.json

@@ -3,26 +3,28 @@
   "name": "sst",
   "type": "module",
   "sideEffects": false,
-  "version": "3.0.14",
+  "version": "3.0.16",
   "main": "./dist/index.js",
   "exports": {
     ".": "./dist/index.js",
-    "./*": [
-      "./dist/*/index.js",
-      "./dist/*.js"
-    ]
+    "./auth": "./dist/auth/index.js",
+    "./auth/adapter": "./dist/auth/adapter.js",
+    "./*": "./dist/*.js"
   },
   "devDependencies": {
     "@tsconfig/node18": "^18.2.2",
     "@types/node": "^20.11.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "hono": "4.3.9"
   },
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "hono": "4.x"
+  },
   "dependencies": {
     "@aws-sdk/client-lambda": "3.478.0",
-    "hono": "4.0.1",
     "jose": "5.2.3",
     "openid-client": "5.6.4"
   },