sst 3.0.15 → 3.0.17

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/realtime/index.d.ts

@@ -13,7 +13,7 @@ export interface RealtimeAuthResult {
      * And to subscribe to all topics under a specific prefix.
      * ```js
      * {
-     *   subscribe: ["chat/#"]
+     *   subscribe: ["chat/*"]
      * }
      * ```
      */
@@ -30,7 +30,7 @@ export interface RealtimeAuthResult {
      * And to publish to all topics under a specific prefix.
      * ```js
      * {
-     *   publish: ["chat/#"]
+     *   publish: ["chat/*"]
      * }
      * ```
      */

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

@@ -1,30 +1,18 @@
 import { Resource } from "../resource.js";
-export interface IngestEvent {
+export interface PutEvent {
     /**
-     * The text used to generate the embedding vector.
-     * At least one of `text` or `image` must be provided.
+     * The vector to store in the database.
      * @example
      * ```js
      * {
-     *   text: "This is an example text.",
+     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
      * }
      * ```
      */
-    text?: string;
-    /**
-     * The base64 representation of the image used to generate the embedding vector.
-     * At least one of `text` or `image` must be provided.
-     * @example
-     * ```js
-     * {
-     *   image: await fs.readFile("./file.jpg").toString("base64"),
-     * }
-     * ```
-     */
-    image?: string;
+    vector: number[];
     /**
      * Metadata for the event in JSON format.
-     * This metadata will be used to filter when retrieving and removing embeddings.
+     * This metadata will be used to filter when quering and removing vectors.
      * @example
      * ```js
      * {
@@ -38,32 +26,20 @@ export interface IngestEvent {
      */
     metadata: Record<string, any>;
 }
-export interface RetrieveEvent {
-    /**
-     * The text prompt used to retrieve embeddings.
-     * At least one of `text` or `image` must be provided.
-     * @example
-     * ```js
-     * {
-     *   text: "This is an example text.",
-     * }
-     * ```
-     */
-    text?: string;
+export interface QueryEvent {
     /**
-     * The base64 representation of the image prompt used to retrive embeddings.
-     * At least one of `text` or `image` must be provided.
+     * The vector used to query the database.
      * @example
      * ```js
      * {
-     *   image: await fs.readFile("./file.jpg").toString("base64"),
+     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
      * }
      * ```
      */
-    image?: string;
+    vector: number[];
     /**
-     * The metadata used to filter the retrieval of embeddings.
-     * Only embeddings with metadata that match the provided fields will be returned.
+     * The metadata used to filter the vectors.
+     * Only vectors that match the provided fields will be returned.
      * @example
      * ```js
      * {
@@ -73,7 +49,7 @@ export interface RetrieveEvent {
      *   }
      * }
      * ```
-     * This will match the embedding with metadata:
+     * This will match the vector with metadata:
      * ```js
      *  {
      *    type: "movie",
@@ -82,7 +58,7 @@ export interface RetrieveEvent {
      *  }
      * ```
      *
-     * But not the embedding with metadata:
+     * But not the vector with metadata:
      * ```js
      *  {
      *    type: "book",
@@ -93,7 +69,7 @@ export interface RetrieveEvent {
      */
     include: Record<string, any>;
     /**
-     * Exclude embeddings with metadata that match the provided fields.
+     * Exclude vectors with metadata that match the provided fields.
      * @example
      * ```js
      * {
@@ -106,7 +82,7 @@ export interface RetrieveEvent {
      *   }
      * }
      * ```
-     * This will match the embedding with metadata:
+     * This will match the vector with metadata:
      * ```js
      *  {
      *    type: "movie",
@@ -115,7 +91,7 @@ export interface RetrieveEvent {
      *  }
      * ```
      *
-     * But not the embedding with metadata:
+     * But not the vector with metadata:
      * ```js
      *  {
      *    type: "book",
@@ -126,11 +102,11 @@ export interface RetrieveEvent {
      */
     exclude?: Record<string, any>;
     /**
-     * The threshold of similarity between the prompt and the retrieved embeddings.
-     * Only embeddings with a similarity score higher than the threshold will be returned.
+     * 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 retrieved embeddings are completely different.
-     * - 1 means the prompt and the retrieved embeddings are identical.
+     * - 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
@@ -154,10 +130,10 @@ export interface RetrieveEvent {
 }
 export interface RemoveEvent {
     /**
-     * The metadata used to filter the removal of embeddings.
-     * Only embeddings with metadata that match the provided fields will be removed.
+     * The metadata used to filter the removal of vectors.
+     * Only vectors with metadata that match the provided fields will be removed.
      * @example
-     * To remove embeddings for movie with id "movie-123":
+     * To remove vectors for movie with id "movie-123":
      * ```js
      * {
      *   include: {
@@ -165,7 +141,7 @@ export interface RemoveEvent {
      *   }
      * }
      * ```
-     * To remove embeddings for all movies:
+     * To remove vectors for all movies:
      * ```js
      *  {
      *   include: {
@@ -176,19 +152,19 @@ export interface RemoveEvent {
      */
     include: Record<string, any>;
 }
-export interface RetrieveResponse {
+export interface QueryResponse {
     /**
-     * Metadata for the event in JSON format that was provided when ingesting the embedding.
+     * 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 retrieved embedding.
+     * The similarity score between the prompt and the queried vector.
      */
     score: number;
 }
 export interface VectorClientResponse {
-    ingest: (event: IngestEvent) => Promise<void>;
-    retrieve: (event: RetrieveEvent) => Promise<RetrieveResponse>;
+    put: (event: PutEvent) => Promise<void>;
+    query: (event: QueryEvent) => Promise<QueryResponse>;
     remove: (event: RemoveEvent) => Promise<void>;
 }
 /**
@@ -198,15 +174,15 @@ export interface VectorClientResponse {
  * import { VectorClient } from "sst";
  * const client = VectorClient("MyVectorDB");
  *
- * // Ingest a text into the vector db
- * await client.ingest({
- *   text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+ * // 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" },
  * });
  *
- * // Retrieve embeddings similar to the provided text
- * const result = await client.retrieve({
- *   text: "Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+ * // 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" },
  * });

package/dist/vector/index.js

@@ -8,15 +8,15 @@ const lambda = new LambdaClient();
  * import { VectorClient } from "sst";
  * const client = VectorClient("MyVectorDB");
  *
- * // Ingest a text into the vector db
- * await client.ingest({
- *   text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
+ * // 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" },
  * });
  *
- * // Retrieve embeddings similar to the provided text
- * const result = await client.retrieve({
- *   text: "Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+ * // 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" },
  * });
@@ -24,26 +24,26 @@ const lambda = new LambdaClient();
  */
 export function VectorClient(name) {
     return {
-        ingest: async (event) => {
+        put: async (event) => {
             const ret = await lambda.send(new InvokeCommand({
                 // @ts-expect-error
-                FunctionName: Resource[name].ingestor,
+                FunctionName: Resource[name].putFunction,
                 Payload: JSON.stringify(event),
             }));
-            parsePayload(ret, "Failed to ingest into the vector db");
+            parsePayload(ret, "Failed to store into the vector db");
         },
-        retrieve: async (event) => {
+        query: async (event) => {
             const ret = await lambda.send(new InvokeCommand({
                 // @ts-expect-error
-                FunctionName: Resource[name].retriever,
+                FunctionName: Resource[name].queryFunction,
                 Payload: JSON.stringify(event),
             }));
-            return parsePayload(ret, "Failed to retrieve from the vector db");
+            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].remover,
+                FunctionName: Resource[name].removeFunction,
                 Payload: JSON.stringify(event),
             }));
             parsePayload(ret, "Failed to remove from the vector db");

package/package.json

@@ -3,26 +3,28 @@
   "name": "sst",
   "type": "module",
   "sideEffects": false,
-  "version": "3.0.15",
+  "version": "3.0.17",
   "main": "./dist/index.js",
   "exports": {
     ".": "./dist/index.js",
-    "./*": [
-      "./dist/*/index.js",
-      "./dist/*.js"
-    ]
+    "./auth": "./dist/auth/index.js",
+    "./auth/adapter": "./dist/auth/index.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"
   },