sst 3.0.37 → 3.0.38

package/bin/sst.mjs

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+
+import path from "path";
+import { execFileSync } from "child_process" 
+const name = `sst-${process.platform}-${process.arch}`;
+const binary = process.platform === "win32" ? "sst.exe" : "sst";
+
+let resolved;
+try {
+  resolved = require.resolve(path.join(name, "bin", binary));
+} catch (ex) {
+  console.error(
+    `It seems that your package manager failed to install the right version of the SST CLI for your platform. You can try manually installing the "${name}" package.`,
+  );
+  process.exit(1);
+}
+
+try {
+  execFileSync(resolved, process.argv.slice(2),
+    {
+    stdio: "inherit", 
+  })
+} catch (ex) {
+  process.exit(1)
+} 
+

package/dist/aws/realtime.d.ts

@@ -1,17 +1,25 @@
 import { Context, IoTCustomAuthorizerEvent } from "aws-lambda";
+/**
+ * The `realtime` client SDK is available through the following.
+ *
+ * @example
+ * ```js title="src/authorizer.ts"
+ * import { realtime } from "sst/aws/realtime";
+ * ```
+ */
 export declare namespace realtime {
     interface AuthResult {
         /**
          * The topics the client can subscribe to.
          * @example
-         * For example, this subscribes to specific topics.
+         * For example, this subscribes to two specific topics.
          * ```js
          * {
          *   subscribe: ["chat/room1", "chat/room2"]
          * }
          * ```
          *
-         * And to subscribe to all topics under a specific prefix.
+         * And to subscribe to all topics under a given prefix.
          * ```js
          * {
          *   subscribe: ["chat/*"]
@@ -22,13 +30,13 @@ export declare namespace realtime {
         /**
          * The topics the client can publish to.
          * @example
-         * For example, this publishes to specific topics.
+         * For example, this publishes to two specific topics.
          * ```js
          * {
          *   publish: ["chat/room1", "chat/room2"]
          * }
          * ```
-         * And to publish to all topics under a specific prefix.
+         * And to publish to all topics under a given prefix.
          * ```js
          * {
          *   publish: ["chat/*"]
@@ -38,21 +46,19 @@ export declare namespace realtime {
         publish?: string[];
     }
     /**
-     * Creates an authorization handler for the `Realtime` component, that validates
+     * Creates an authorization handler for the `Realtime` component. It validates
      * the token and grants permissions for the topics the client can subscribe and publish to.
      *
      * @example
-     * ```js
-     * import { realtime } from "sst/aws/realtime";
-     *
+     * ```js title="src/authorizer.ts" "realtime.authorizer"
      * export const handler = realtime.authorizer(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`],
+     *     subscribe: ["*"],
+     *     publish: ["*"],
      *   };
      * });
      * ```

package/dist/aws/realtime.js

@@ -1,21 +1,27 @@
+/**
+ * The `realtime` client SDK is available through the following.
+ *
+ * @example
+ * ```js title="src/authorizer.ts"
+ * import { realtime } from "sst/aws/realtime";
+ * ```
+ */
 export var realtime;
 (function (realtime) {
     /**
-     * Creates an authorization handler for the `Realtime` component, that validates
+     * Creates an authorization handler for the `Realtime` component. It validates
      * the token and grants permissions for the topics the client can subscribe and publish to.
      *
      * @example
-     * ```js
-     * import { realtime } from "sst/aws/realtime";
-     *
+     * ```js title="src/authorizer.ts" "realtime.authorizer"
      * export const handler = realtime.authorizer(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`],
+     *     subscribe: ["*"],
+     *     publish: ["*"],
      *   };
      * });
      * ```

package/dist/resource.js

@@ -45,6 +45,13 @@ export const Resource = new Proxy(raw, {
         if (prop in raw) {
             return raw[prop];
         }
-        throw new Error(`"${prop}" is not linked`);
+        if (!env.SST_RESOURCE_App) {
+            throw new Error("It does not look like SST links are active. If this is in local development and you are not starting this process through the multiplexer, wrap your command with `sst dev -- <command>`");
+        }
+        let msg = `"${prop}" is not linked in your sst.config.ts`;
+        if (env.AWS_LAMBDA_FUNCTION_NAME) {
+            msg += ` to ${env.AWS_LAMBDA_FUNCTION_NAME}`;
+        }
+        throw new Error(msg);
     },
 });

package/dist/vector/index.d.ts

@@ -5,21 +5,21 @@ export interface PutEvent {
      * @example
      * ```js
      * {
-     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+     *   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.
+     * Metadata for the event as JSON.
+     * This will be used to filter when querying and removing vectors.
      * @example
      * ```js
      * {
      *   metadata: {
      *     type: "movie",
      *     id: "movie-123",
-     *     name: "Spiderman",
+     *     name: "Spiderman"
      *   }
      * }
      * ```
@@ -32,7 +32,7 @@ export interface QueryEvent {
      * @example
      * ```js
      * {
-     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9]
      * }
      * ```
      */
@@ -41,29 +41,30 @@ export interface QueryEvent {
      * The metadata used to filter the vectors.
      * Only vectors that match the provided fields will be returned.
      * @example
+     * Given this filter.
      * ```js
      * {
      *   include: {
      *     type: "movie",
-     *     release: "2001",
+     *     release: "2001"
      *   }
      * }
      * ```
-     * This will match the vector with metadata:
+     * It will match a vector with the metadata:
      * ```js
-     *  {
-     *    type: "movie",
-     *    name: "Spiderman",
-     *    release: "2001",
-     *  }
+     * {
+     *   type: "movie",
+     *   name: "Spiderman",
+     *   release: "2001"
+     * }
      * ```
      *
-     * But not the vector with metadata:
+     * But not a vector with this metadata:
      * ```js
      *  {
      *    type: "book",
      *    name: "Spiderman",
-     *    release: "2001",
+     *    release: "2001"
      *  }
      * ```
      */
@@ -71,32 +72,33 @@ export interface QueryEvent {
     /**
      * Exclude vectors with metadata that match the provided fields.
      * @example
+     * Given this filter.
      * ```js
      * {
      *   include: {
      *     type: "movie",
-     *     release: "2001",
+     *     release: "2001"
      *   },
      *   exclude: {
-     *     name: "Spiderman",
+     *     name: "Spiderman"
      *   }
      * }
      * ```
-     * This will match the vector with metadata:
+     * This will match a vector with metadata:
      * ```js
      *  {
      *    type: "movie",
      *    name: "A Beautiful Mind",
-     *    release: "2001",
+     *    release: "2001"
      *  }
      * ```
      *
-     * But not the vector with metadata:
+     * But not a vector with the metadata:
      * ```js
      *  {
      *    type: "book",
      *    name: "Spiderman",
-     *    release: "2001",
+     *    release: "2001"
      *  }
      * ```
      */
@@ -104,14 +106,16 @@ export interface QueryEvent {
     /**
      * 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.
+     *
+     * This will return values 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: 0.5
      * }
      * ```
      */
@@ -122,7 +126,7 @@ export interface QueryEvent {
      * @example
      * ```js
      * {
-     *   count: 10,
+     *   count: 10
      * }
      * ```
      */
@@ -133,7 +137,7 @@ 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":
+     * To remove vectors for movie with id `movie-123`:
      * ```js
      * {
      *   include: {
@@ -141,7 +145,7 @@ export interface RemoveEvent {
      *   }
      * }
      * ```
-     * To remove vectors for all movies:
+     * To remove vectors for all _movies_:
      * ```js
      *  {
      *   include: {
@@ -154,33 +158,74 @@ export interface RemoveEvent {
 }
 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.
+     * List of results matching the query.
      */
-    score: number;
+    results: {
+        /**
+         * Metadata for the event 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 {
+    /**
+     * Store a vector into the database.
+     * @example
+     * ```ts title="src/lambda.ts"
+     * await client.put({
+     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+     *   metadata: { type: "movie", genre: "comedy" },
+     * });
+     * ```
+     */
     put: (event: PutEvent) => Promise<void>;
+    /**
+     * Query vectors that are similar to the given vector
+     * @example
+     * ```ts title="src/lambda.ts"
+     * const result = await client.query({
+     *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
+     *   include: { type: "movie" },
+     *   exclude: { genre: "thriller" },
+     * });
+     * ```
+     */
     query: (event: QueryEvent) => Promise<QueryResponse>;
+    /**
+     * Remove vectors from the database.
+     * @example
+     * ```ts title="src/lambda.ts"
+     * await client.remove({
+     *   include: { type: "movie" },
+     * });
+     * ```
+     */
     remove: (event: RemoveEvent) => Promise<void>;
 }
 /**
  * Create a client to interact with the Vector database.
  * @example
- * ```js
+ * ```ts title="src/lambda.ts"
  * import { VectorClient } from "sst";
  * const client = VectorClient("MyVectorDB");
+ * ```
  *
- * // Store a vector into the db
+ * Store a vector into the db
+ *
+ * ```ts title="src/lambda.ts"
  * await client.put({
  *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
  *   metadata: { type: "movie", genre: "comedy" },
  * });
+ * ```
+ *
+ * Query vectors that are similar to the given vector
  *
- * // Query vectors similar to the provided vector
+ * ```ts title="src/lambda.ts"
  * const result = await client.query({
  *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
  *   include: { type: "movie" },

package/dist/vector/index.js

@@ -4,17 +4,23 @@ const lambda = new LambdaClient();
 /**
  * Create a client to interact with the Vector database.
  * @example
- * ```js
+ * ```ts title="src/lambda.ts"
  * import { VectorClient } from "sst";
  * const client = VectorClient("MyVectorDB");
+ * ```
+ *
+ * Store a vector into the db
  *
- * // Store a vector into the db
+ * ```ts title="src/lambda.ts"
  * await client.put({
  *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
  *   metadata: { type: "movie", genre: "comedy" },
  * });
+ * ```
+ *
+ * Query vectors that are similar to the given vector
  *
- * // Query vectors similar to the provided vector
+ * ```ts title="src/lambda.ts"
  * const result = await client.query({
  *   vector: [32.4, 6.55, 11.2, 10.3, 87.9],
  *   include: { type: "movie" },

package/package.json

@@ -3,7 +3,7 @@
   "name": "sst",
   "type": "module",
   "sideEffects": false,
-  "version": "3.0.37",
+  "version": "3.0.38",
   "main": "./dist/index.js",
   "exports": {
     ".": "./dist/index.js",
@@ -13,17 +13,27 @@
     "./realtime": "./dist/realtime/index.js",
     "./*": "./dist/*.js"
   },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w",
+    "release": "./scripts/release.ts"
+  },
   "devDependencies": {
-    "@tsconfig/node18": "^18.2.2",
-    "@types/node": "^20.11.0",
+    "@tsconfig/node20": "20.1.4",
+    "@types/bun": "^1.1.6",
+    "@types/node": "20.11.0",
     "hono": "4.3.9",
-    "typescript": "^5.3.3",
+    "typescript": "5.3.3",
     "valibot": "0.30.0",
-    "zod": "^3.23.8"
+    "zod": "3.23.8"
   },
   "files": [
-    "dist"
+    "dist",
+    "bin"
   ],
+  "bin": {
+    "sst": "./bin/sst.mjs"
+  },
   "peerDependencies": {
     "hono": "4.x",
     "valibot": "0.30.x"
@@ -36,16 +46,17 @@
       "optional": true
     }
   },
+  "optionalDependencies": {
+    "sst-linux-x64": "3.0.38",
+    "sst-linux-x86": "3.0.38",
+    "sst-linux-arm64": "3.0.38",
+    "sst-darwin-x64": "3.0.38",
+    "sst-darwin-arm64": "3.0.38"
+  },
   "dependencies": {
     "@aws-sdk/client-lambda": "3.478.0",
-    "@tsconfig/node20": "^20.1.4",
     "aws4fetch": "^1.0.18",
     "jose": "5.2.3",
     "openid-client": "5.6.4"
-  },
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc -w",
-    "release": "bun run build && pnpm version patch && pnpm publish --no-git-checks --tag=ion --access=public"
   }
 }

package/dist/src/auth/adapter/adapter.d.ts

@@ -1,24 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import type { Context, Hono } from "hono";
-import { KeyLike } from "jose";
-export type Adapter<Properties = any> = (route: AdapterRoute, options: AdapterOptions<Properties>) => void;
-export type AdapterRoute = Hono;
-export interface AdapterOptions<Properties> {
-    name: string;
-    algorithm: string;
-    encryption: {
-        publicKey: () => Promise<KeyLike>;
-        privateKey: () => Promise<KeyLike>;
-    };
-    signing: {
-        publicKey: () => Promise<KeyLike>;
-        privateKey: () => Promise<KeyLike>;
-    };
-    success: (ctx: Context, properties: Properties) => Promise<Response>;
-    forward: (ctx: Context, response: Response) => Response;
-    cookie: (ctx: Context, key: string, value: string, maxAge: number) => void;
-}
-export declare class AdapterError extends Error {
-}
-export declare class AdapterUnknownError extends AdapterError {
-}

package/dist/src/auth/adapter/adapter.js

@@ -1,4 +0,0 @@
-export class AdapterError extends Error {
-}
-export class AdapterUnknownError extends AdapterError {
-}

package/dist/src/auth/adapter/apple.d.ts

@@ -1,5 +0,0 @@
-import { OauthBasicConfig } from "./oauth.js";
-export declare const AppleAdapter: (config: OauthBasicConfig) => (routes: import("./adapter.js").AdapterRoute, ctx: import("./adapter.js").AdapterOptions<{
-    tokenset: import("openid-client").TokenSet;
-    client: import("openid-client").BaseClient;
-}>) => Promise<void>;

package/dist/src/auth/adapter/apple.js

@@ -1,22 +0,0 @@
-import { Issuer } from "openid-client";
-import { OauthAdapter } from "./oauth.js";
-// This adapter support the OAuth flow with the response_mode "form_post" for now.
-// More details about the flow:
-// https://developer.apple.com/documentation/devicemanagement/user_enrollment/onboarding_users_with_account_sign-in/implementing_the_oauth2_authentication_user-enrollment_flow
-//
-// Also note that Apple's discover uri does not work for the OAuth flow, as the
-// userinfo_endpoint are not included in the response.
-// await Issuer.discover("https://appleid.apple.com/.well-known/openid-configuration/");
-const issuer = await Issuer.discover("https://appleid.apple.com/.well-known/openid-configuration");
-export const AppleAdapter = 
-/* @__PURE__ */
-(config) => {
-    return OauthAdapter({
-        issuer,
-        ...config,
-        params: {
-            ...config.params,
-            response_mode: "form_post",
-        },
-    });
-};

package/dist/src/auth/adapter/code.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-export declare function CodeAdapter(config: {
-    length?: number;
-    onCodeRequest: (code: string, claims: Record<string, any>, req: Request) => Promise<Response>;
-    onCodeInvalid: (code: string, claims: Record<string, any>, req: Request) => Promise<Response>;
-}): (routes: import("./adapter.js").AdapterRoute, ctx: import("./adapter.js").AdapterOptions<{
-    claims: Record<string, string>;
-}>) => void;

package/dist/src/auth/adapter/code.js

@@ -1,47 +0,0 @@
-import { deleteCookie, getCookie } from "hono/cookie";
-import { UnknownStateError } from "../index.js";
-import { CompactEncrypt, compactDecrypt } from "jose";
-export function CodeAdapter(config) {
-    const length = config.length || 6;
-    function generate() {
-        const buffer = crypto.getRandomValues(new Uint8Array(length));
-        const otp = Array.from(buffer)
-            .map((byte) => byte % 10)
-            .join("");
-        return otp;
-    }
-    return function (routes, ctx) {
-        routes.get("/authorize", async (c) => {
-            const code = generate();
-            const claims = c.req.query();
-            delete claims["client_id"];
-            delete claims["redirect_uri"];
-            delete claims["response_type"];
-            delete claims["provider"];
-            const authorization = await new CompactEncrypt(new TextEncoder().encode(JSON.stringify({
-                claims,
-                code,
-            })))
-                .setProtectedHeader({ alg: "RSA-OAEP-512", enc: "A256GCM" })
-                .encrypt(await ctx.encryption.publicKey());
-            ctx.cookie(c, "authorization", authorization, 60 * 10);
-            return ctx.forward(c, await config.onCodeRequest(code, claims, c.req.raw));
-        });
-        routes.get("/callback", async (c) => {
-            const authorization = getCookie(c, "authorization");
-            if (!authorization)
-                throw new UnknownStateError();
-            const { code, claims } = JSON.parse(new TextDecoder().decode(await compactDecrypt(authorization, await ctx.encryption.privateKey()).then((value) => value.plaintext)));
-            if (!code || !claims) {
-                return ctx.forward(c, await config.onCodeInvalid(code, claims, c.req.raw));
-            }
-            const compare = c.req.query("code");
-            console.log("comparing", code, "to", compare);
-            if (code !== compare) {
-                return ctx.forward(c, await config.onCodeInvalid(code, claims, c.req.raw));
-            }
-            deleteCookie(c, "authorization");
-            return ctx.forward(c, await ctx.success(c, { claims }));
-        });
-    };
-}

package/dist/src/auth/adapter/facebook.d.ts

@@ -1,5 +0,0 @@
-import { OauthBasicConfig } from "./oauth.js";
-export declare const FacebookAdapter: (config: OauthBasicConfig) => (routes: import("./adapter.js").AdapterRoute, ctx: import("./adapter.js").AdapterOptions<{
-    tokenset: import("openid-client").TokenSet;
-    client: import("openid-client").BaseClient;
-}>) => Promise<void>;

package/dist/src/auth/adapter/facebook.js

@@ -1,27 +0,0 @@
-import { Issuer } from "openid-client";
-import { OauthAdapter } from "./oauth.js";
-// Facebook's OIDC flow returns "id_token" as uri hash in redirect uri. Hashes
-// are not passed to Lambda event object. It is likely that Facebook only wants
-// to support redirecting to a frontend uri.
-//
-// We are only going to support the OAuth flow for now. More details about the flow:
-// https://developers.facebook.com/docs/facebook-login/guides/advanced/oidc-token
-//
-// Also note that Facebook's discover uri does not work for the OAuth flow, as the
-// token_endpoint and userinfo_endpoint are not included in the response.
-// await Issuer.discover("https://www.facebook.com/.well-known/openid-configuration/");
-const issuer = new Issuer({
-    issuer: "https://www.facebook.com",
-    authorization_endpoint: "https://facebook.com/dialog/oauth/",
-    jwks_uri: "https://www.facebook.com/.well-known/oauth/openid/jwks/",
-    token_endpoint: "https://graph.facebook.com/oauth/access_token",
-    userinfo_endpoint: "https://graph.facebook.com/oauth/access_token",
-});
-export const FacebookAdapter = 
-/* @__PURE__ */
-(config) => {
-    return OauthAdapter({
-        issuer,
-        ...config,
-    });
-};

package/dist/src/auth/adapter/github.d.ts

@@ -1,12 +0,0 @@
-import { OauthBasicConfig } from "./oauth.js";
-import { OidcBasicConfig } from "./oidc.js";
-type Config = ({
-    mode: "oauth";
-} & OauthBasicConfig) | ({
-    mode: "oidc";
-} & OidcBasicConfig);
-export declare const GithubAdapter: (config: Config) => (routes: import("./adapter.js").AdapterRoute, ctx: import("./adapter.js").AdapterOptions<{
-    tokenset: import("openid-client").TokenSet;
-    client: import("openid-client").BaseClient;
-}>) => Promise<void>;
-export {};