@tailor-platform/sdk 2.0.0-next.1 → 2.0.0-next.10

package/dist/configure/services/secrets/index.d.mts

@@ -0,0 +1,37 @@
+import { SecretsConfig, SecretsDefinitionBrand } from "./types.mjs";
+//#region src/configure/services/secrets/index.d.ts
+type SecretsVaultInput = Record<string, string>;
+type SecretsVaultInputNullish = Record<string, string | undefined | null>;
+type SecretsInput = Record<string, SecretsVaultInput>;
+type SecretsInputNullish = Record<string, SecretsVaultInputNullish>;
+type SecretsOptions = {
+  readonly ignoreNullishValues: boolean;
+};
+type DefinedSecrets<T extends SecretsInputNullish> = {
+  readonly vaults: T;
+  readonly options: SecretsOptions;
+  get<V extends Extract<keyof T, string>, S extends Extract<keyof T[V], string>>(vault: V, secret: S): Promise<string | undefined>;
+  getAll<V extends Extract<keyof T, string>, S extends Extract<keyof T[V], string>>(vault: V, secrets: readonly S[]): Promise<(string | undefined)[]>;
+} & SecretsDefinitionBrand;
+/**
+ * Define secrets configuration for the Tailor SDK.
+ * Each key is a vault name, and its value is a record of secret name to secret value.
+ * @param config - Secrets configuration mapping vault names to their secrets
+ * @returns Defined secrets with typed runtime access methods
+ */
+declare function defineSecretManager<const T extends SecretsInput>(config: T): DefinedSecrets<T>;
+/**
+ * Define secrets configuration for the Tailor SDK with ignoreNullishValues option.
+ * When `ignoreNullishValues` is true, secrets with nullish values are skipped during deploy
+ * instead of causing an error. This is useful for CI environments where not all
+ * secret values are available.
+ * @param config - Secrets configuration mapping vault names to their secrets
+ * @param options - Options for secret management behavior
+ * @param options.ignoreNullishValues - When true, secrets with nullish values are skipped during deploy
+ * @returns Defined secrets with typed runtime access methods
+ */
+declare function defineSecretManager<const T extends SecretsInputNullish>(config: T, options: {
+  ignoreNullishValues: true;
+}): DefinedSecrets<T>;
+//#endregion
+export { type SecretsConfig, defineSecretManager };

package/dist/configure/services/secrets/types.d.mts

@@ -0,0 +1,10 @@
+import { SecretsInput } from "../../../types/secrets.generated.mjs";
+//#region src/configure/services/secrets/types.d.ts
+declare const secretsDefinitionBrand: unique symbol;
+type SecretsDefinitionBrand = {
+  readonly [secretsDefinitionBrand]: true;
+};
+/** Type accepted by `AppConfig.secrets`. Only values returned by `defineSecretManager()` satisfy this. */
+type SecretsConfig = SecretsInput & SecretsDefinitionBrand;
+//#endregion
+export { SecretsConfig, SecretsDefinitionBrand };

package/dist/configure/services/staticwebsite/index.d.mts

@@ -0,0 +1,18 @@
+import { StaticWebsiteInput } from "../../../types/staticwebsite.generated.mjs";
+import { StaticWebsiteConfig, StaticWebsiteDefinitionBrand } from "./types.mjs";
+//#region src/configure/services/staticwebsite/index.d.ts
+/**
+ * Define a static website configuration for the Tailor SDK.
+ * @param name - Static website name
+ * @param config - Static website configuration
+ * @returns Defined static website
+ */
+declare function defineStaticWebSite(name: string, config: Omit<StaticWebsiteInput, "name">): {
+  readonly name: string;
+  readonly url: `${string}:url`;
+  readonly description?: string | undefined;
+  readonly allowedIpAddresses?: string[] | undefined;
+  readonly customDomains?: string[] | undefined;
+} & StaticWebsiteDefinitionBrand;
+//#endregion
+export { type StaticWebsiteConfig, defineStaticWebSite };

package/dist/configure/services/staticwebsite/types.d.mts

@@ -0,0 +1,10 @@
+import { StaticWebsiteInput } from "../../../types/staticwebsite.generated.mjs";
+//#region src/configure/services/staticwebsite/types.d.ts
+declare const staticWebsiteDefinitionBrand: unique symbol;
+type StaticWebsiteDefinitionBrand = {
+  readonly [staticWebsiteDefinitionBrand]: true;
+};
+/** Type accepted by `AppConfig.staticWebsites`. Only values returned by `defineStaticWebSite()` satisfy this. */
+type StaticWebsiteConfig = StaticWebsiteInput & StaticWebsiteDefinitionBrand;
+//#endregion
+export { StaticWebsiteConfig, StaticWebsiteDefinitionBrand };

package/dist/configure/services/tailordb/index.d.mts

@@ -0,0 +1,4 @@
+import { DBFieldMetadata, GqlOperationsConfig, Hook, TailorDBServiceInput, TypeFeatures } from "./types.mjs";
+import { PermissionCondition, TailorTypeGqlPermission, TailorTypePermission, unsafeAllowAllGqlPermission, unsafeAllowAllTypePermission } from "./permission.mjs";
+import { TailorAnyDBField, TailorAnyDBType, TailorDBField, TailorDBInstance, TailorDBType, db } from "./schema.mjs";
+export { type PermissionCondition, type TailorAnyDBField, type TailorAnyDBType, type TailorDBField, type TailorDBInstance, type TailorDBType, type TailorTypeGqlPermission, type TailorTypePermission, db, unsafeAllowAllGqlPermission, unsafeAllowAllTypePermission };

package/dist/configure/services/tailordb/permission.d.mts

@@ -0,0 +1,103 @@
+import { InferredAttributes } from "../../../runtime/types.mjs";
+import { UserBooleanArrayOperand, UserBooleanOperand, UserStringArrayOperand, UserStringOperand } from "../../types/permission-operand.types.mjs";
+//#region src/configure/services/tailordb/permission.d.ts
+/**
+ * Record-level permission configuration for a TailorDB type.
+ * Defines create, read, update, and delete permissions.
+ *
+ * Prefer object format with explicit `conditions` and `permit` for readability.
+ * Shorthand array format is supported for compatibility, but less readable.
+ *
+ * For update operations, use `newRecord`/`oldRecord` operands instead of `record`.
+ * @example
+ * const permission: TailorTypePermission = {
+ *   create: [{ conditions: [[{ user: "_loggedIn" }, "=", true]], permit: true }],
+ *   read: [{ conditions: [[{ record: "isPublic" }, "=", true]], permit: true }],
+ *   update: [{ conditions: [[{ newRecord: "ownerId" }, "=", { user: "id" }]], permit: true }],
+ *   delete: [{ conditions: [[{ record: "ownerId" }, "=", { user: "id" }]], permit: true }],
+ * };
+ */
+type TailorTypePermission<User extends object = InferredAttributes, Type extends object = object> = {
+  create: readonly ActionPermission<"record", User, Type, false>[];
+  read: readonly ActionPermission<"record", User, Type, false>[];
+  update: readonly ActionPermission<"record", User, Type, true>[];
+  delete: readonly ActionPermission<"record", User, Type, false>[];
+};
+type ActionPermission<Level extends "record" | "gql" = "record" | "gql", User extends object = InferredAttributes, Type extends object = object, Update extends boolean = boolean> = {
+  conditions: PermissionCondition<Level, User, Update, Type> | readonly PermissionCondition<Level, User, Update, Type>[];
+  description?: string | undefined;
+  /**
+   * Whether matching records are granted (`true`) or denied (`false`).
+   * Omitting `permit` in this object form defaults to `deny` and emits a
+   * warning; set it explicitly. (The array shorthand defaults to `allow`.)
+   */
+  permit?: boolean;
+} | readonly [...PermissionCondition<Level, User, Update, Type>, ...([] | [boolean])] | readonly [...PermissionCondition<Level, User, Update, Type>[], ...([] | [boolean])];
+type TailorTypeGqlPermission<User extends object = InferredAttributes, Type extends object = object> = readonly GqlPermissionPolicy<User, Type>[];
+type GqlPermissionPolicy<User extends object = InferredAttributes, Type extends object = object> = {
+  conditions: readonly PermissionCondition<"gql", User, boolean, Type>[];
+  actions: "all" | readonly GqlPermissionAction[];
+  /**
+   * Whether matching requests are granted (`true`) or denied (`false`).
+   * Omitting `permit` defaults to `deny` and emits a warning; set it explicitly.
+   */
+  permit?: boolean;
+  description?: string;
+};
+type GqlPermissionAction = "read" | "create" | "update" | "delete" | "aggregate" | "bulkUpsert";
+type EqualityOperator = "=" | "!=";
+type ContainsOperator = "in" | "not in";
+type HasAnyOperator = "hasAny" | "not hasAny";
+type RecordOperand<Type extends object, Update extends boolean = false> = Update extends true ? {
+  oldRecord: (keyof Type & string) | "id";
+} | {
+  newRecord: (keyof Type & string) | "id";
+} : {
+  record: (keyof Type & string) | "id";
+};
+type StringEqualityCondition<Level extends "record" | "gql", User extends object, Update extends boolean, Type extends object> = (Level extends "gql" ? readonly [string, EqualityOperator, boolean] : never) | readonly [string, EqualityOperator, string] | readonly [UserStringOperand<User>, EqualityOperator, string] | readonly [string, EqualityOperator, UserStringOperand<User>] | (Level extends "record" ? readonly [RecordOperand<Type, Update>, EqualityOperator, string | UserStringOperand<User>] | readonly [string | UserStringOperand<User>, EqualityOperator, RecordOperand<Type, Update>] : never);
+type BooleanEqualityCondition<Level extends "record" | "gql", User extends object, Update extends boolean, Type extends object> = readonly [boolean, EqualityOperator, boolean] | readonly [UserBooleanOperand<User>, EqualityOperator, boolean] | readonly [boolean, EqualityOperator, UserBooleanOperand<User>] | (Level extends "record" ? readonly [RecordOperand<Type, Update>, EqualityOperator, boolean | UserBooleanOperand<User>] | readonly [boolean | UserBooleanOperand<User>, EqualityOperator, RecordOperand<Type, Update>] : never);
+type EqualityCondition<Level extends "record" | "gql" = "record", User extends object = InferredAttributes, Update extends boolean = boolean, Type extends object = object> = StringEqualityCondition<Level, User, Update, Type> | BooleanEqualityCondition<Level, User, Update, Type>;
+type StringContainsCondition<Level extends "record" | "gql", User extends object, Update extends boolean, Type extends object> = readonly [string, ContainsOperator, string[]] | readonly [UserStringOperand<User>, ContainsOperator, string[]] | readonly [string, ContainsOperator, UserStringArrayOperand<User>] | (Level extends "record" ? readonly [RecordOperand<Type, Update>, ContainsOperator, string[] | UserStringArrayOperand<User>] | readonly [string | UserStringOperand<User>, ContainsOperator, RecordOperand<Type, Update>] : never);
+type BooleanContainsCondition<Level extends "record" | "gql", User extends object, Update extends boolean, Type extends object> = (Level extends "gql" ? readonly [string, ContainsOperator, boolean[]] : never) | readonly [boolean, ContainsOperator, boolean[]] | readonly [UserBooleanOperand<User>, ContainsOperator, boolean[]] | readonly [boolean, ContainsOperator, UserBooleanArrayOperand<User>] | (Level extends "record" ? readonly [RecordOperand<Type, Update>, ContainsOperator, boolean[] | UserBooleanArrayOperand<User>] | readonly [boolean | UserBooleanOperand<User>, ContainsOperator, RecordOperand<Type, Update>] : never);
+type ContainsCondition<Level extends "record" | "gql" = "record", User extends object = InferredAttributes, Update extends boolean = boolean, Type extends object = object> = StringContainsCondition<Level, User, Update, Type> | BooleanContainsCondition<Level, User, Update, Type>;
+type HasAnyCondition<Level extends "record" | "gql", User extends object, Update extends boolean, Type extends object> = readonly [string[] | UserStringArrayOperand<User>, HasAnyOperator, string[] | UserStringArrayOperand<User>] | (Level extends "record" ? readonly [RecordOperand<Type, Update>, HasAnyOperator, string[] | UserStringArrayOperand<User>] | readonly [string[] | UserStringArrayOperand<User>, HasAnyOperator, RecordOperand<Type, Update>] : never);
+/**
+ * Type representing a permission condition that combines user attributes, record fields, and literal values using comparison operators.
+ *
+ * The User type is extended by `tailor.d.ts`, which is automatically generated when running `tailor generate`.
+ * Attributes enabled in the config file's `auth.userProfile.attributes` (or
+ * `auth.machineUserAttributes` when userProfile is omitted) become available as types.
+ * @example
+ * ```ts
+ * // tailor.config.ts
+ * export const auth = defineAuth("my-auth", {
+ *   userProfile: {
+ *     type: user,
+ *     attributes: {
+ *       isAdmin: true,
+ *       roles: true,
+ *     }
+ *   }
+ * });
+ * ```
+ */
+type PermissionCondition<Level extends "record" | "gql" = "record", User extends object = InferredAttributes, Update extends boolean = boolean, Type extends object = object> = EqualityCondition<Level, User, Update, Type> | ContainsCondition<Level, User, Update, Type> | HasAnyCondition<Level, User, Update, Type>;
+/**
+ * Grants full record-level access without any conditions.
+ *
+ * Unsafe and intended only for local development, prototyping, or tests.
+ * Do not use this in production environments, as it effectively disables
+ * authorization checks.
+ */
+declare const unsafeAllowAllTypePermission: TailorTypePermission;
+/**
+ * Grants full GraphQL access (all actions) without any conditions.
+ *
+ * Unsafe and intended only for local development, prototyping, or tests.
+ * Do not use this in production environments, as it effectively disables
+ * authorization checks.
+ */
+declare const unsafeAllowAllGqlPermission: TailorTypeGqlPermission;
+//#endregion
+export { PermissionCondition, TailorTypeGqlPermission, TailorTypePermission, unsafeAllowAllGqlPermission, unsafeAllowAllTypePermission };