@tulip-systems/drive-local 0.11.1

package/dist/client.mjs

@@ -0,0 +1,12 @@
+import { LocalDriveFileUpdateCommand } from "./root/components/command-file-update.mjs";
+import { DriveUploadZoneContext, LocalDriveUploadZoneContext, useDriveUploadZone, useLocalDriveUploadZone } from "./root/components/upload-zone-context.client.mjs";
+import { LocalDriveFilesUploadCommand } from "./root/components/command-file-upload.mjs";
+import { LocalDriveFoldersCreateCommand } from "./root/components/command-folder-create.mjs";
+import { LocalDriveFoldersUpdateCommand } from "./root/components/command-folder-update.mjs";
+import { LocalDriveContent } from "./root/components/content.client.mjs";
+import { LocalDriveHeader, LocalDriveHeaderBreadcrumbs, LocalDriveHeaderTools, LocalDriveToolbar, LocalDriveToolbarBreadcrumbs, LocalDriveToolbarTools, LocalDriveViewSwitcher } from "./root/components/navigation.client.mjs";
+import { DriveUploadZone, LocalDriveUploadZone } from "./root/components/upload-zone.client.mjs";
+import { LocalDriveContext, LocalDriveProvider, useLocalDriveContext } from "./root/components/provider.client.mjs";
+import { LocalDriveView, LocalDriveViewLoading, LocalDriveViewProvider } from "./root/components/view.client.mjs";
+import { createLocalDriveUploadClient } from "./root/lib/upload.client.mjs";
+export { DriveUploadZone, DriveUploadZoneContext, LocalDriveContent, LocalDriveContext, LocalDriveFileUpdateCommand, LocalDriveFilesUploadCommand, LocalDriveFoldersCreateCommand, LocalDriveFoldersUpdateCommand, LocalDriveHeader, LocalDriveHeaderBreadcrumbs, LocalDriveHeaderTools, LocalDriveProvider, LocalDriveToolbar, LocalDriveToolbarBreadcrumbs, LocalDriveToolbarTools, LocalDriveUploadZone, LocalDriveUploadZoneContext, LocalDriveView, LocalDriveViewLoading, LocalDriveViewProvider, LocalDriveViewSwitcher, createLocalDriveUploadClient, useDriveUploadZone, useLocalDriveContext, useLocalDriveUploadZone };

package/dist/database/drizzle/lib/adapter.d.mts

@@ -0,0 +1,310 @@
+import { LocalNode } from "../../../root/lib/validators.mjs";
+import { LocalDriveDatabaseCreateNodeInput, LocalDriveDatabaseCreateVariantInput, LocalDriveDatabaseDeleteNodesInput, LocalDriveDatabaseFindFirstNodeInput, LocalDriveDatabaseFindFirstPresignedUrlInput, LocalDriveDatabaseFindNodesInput, LocalDriveDatabaseFindVariantsInput, LocalDriveDatabaseListNodesWithAssetInput, LocalDriveDatabaseNodeChild, LocalDriveDatabaseUpdateNodesInput, UpsertLocalDrivePresignedUrlInput } from "../../../root/lib/database/contracts.mjs";
+import "../../../server.mjs";
+import { LocalDriveDrizzleSchema } from "./schema.mjs";
+import { NodePgDatabase } from "drizzle-orm/node-postgres";
+//#region src/database/drizzle/lib/adapter.d.ts
+type LocalDriveDrizzleAdapterConfig<TSchema extends Record<string, unknown>, TDriveSchema extends LocalDriveDrizzleSchema> = {
+  db: NodePgDatabase<TSchema>;
+  schema: TDriveSchema;
+};
+/**
+ * Creates the Drizzle database adapter for the local drive package.
+ *
+ * The local drive package owns the drive behavior, but the consumer app owns the
+ * Drizzle schema and migrations. Pass the app's `db` instance and a schema map
+ * with the local drive tables under the expected contract keys.
+ *
+ * @example
+ * import { localDriveDrizzleAdapter } from "@tulip-systems/drive-local/drizzle";
+ * import { LocalDrive } from "@tulip-systems/drive-local/server";
+ * import * as driveSchema from "@/server/drive-local/schema";
+ * import * as storageSchema from "@/server/storage/schema";
+ *
+ * export const drive = new LocalDrive({
+ *   database: localDriveDrizzleAdapter({
+ *     db,
+ *     schema: { ...driveSchema, storageAssets: storageSchema.storageAssets },
+ *   }),
+ *   storage,
+ * });
+ *
+ * @example
+ * // You can also remap app-owned table names to the local drive contract keys.
+ * localDriveDrizzleAdapter({
+ *   db,
+ *   schema: {
+ *     nodes: driveNodes,
+ *     nodeVariants: driveNodeVariants,
+ *     nodePresignedUrls: driveNodePresignedUrls,
+ *     storageAssets: assets,
+ *   },
+ * });
+ */
+declare function localDriveDrizzleAdapter<TSchema extends Record<string, unknown>, TDriveSchema extends LocalDriveDrizzleSchema>({ db, schema }: LocalDriveDrizzleAdapterConfig<TSchema, TDriveSchema>): {
+  db: NodePgDatabase<TSchema>;
+  schema: TDriveSchema;
+  /**
+   * Finds a local drive node by its primary id.
+   *
+   * @example
+   * const node = await database.findNodeById("019d...");
+   */
+  findNodeById: (id: string) => Promise<{
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    name: string;
+    namespace: string;
+    type: ("folder" | "file") | null;
+    subtype: "image" | "document" | "spreadsheet" | "video" | "audio" | "archive" | "other";
+    size: number | null;
+    contentType: string | null;
+    readonly: boolean | null;
+    hidden: boolean | null;
+    archivedAt: Date | null;
+    parentId: string | null;
+    assetId: string | null;
+  } | null>;
+  /**
+   * Finds the first local drive node matching the provided database filters.
+   *
+   * @example
+   * const node = await database.findFirstNode({ filters: { assetIds: [asset.id] } });
+   */
+  findFirstNode: (input: LocalDriveDatabaseFindFirstNodeInput | undefined) => Promise<{
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    name: string;
+    namespace: string;
+    type: ("folder" | "file") | null;
+    subtype: "image" | "document" | "spreadsheet" | "video" | "audio" | "archive" | "other";
+    size: number | null;
+    contentType: string | null;
+    readonly: boolean | null;
+    hidden: boolean | null;
+    archivedAt: Date | null;
+    parentId: string | null;
+    assetId: string | null;
+  } | null>;
+  /**
+   * Finds local drive nodes matching the provided filters, sorts, and pagination limits.
+   *
+   * @example
+   * const nodes = await database.findNodes({
+   *   filters: { namespace: "products", parentId: null },
+   *   sorts: [{ key: "name", direction: "asc" }],
+   * });
+   */
+  findNodes: (input?: LocalDriveDatabaseFindNodesInput | undefined) => Promise<{
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    name: string;
+    namespace: string;
+    type: ("folder" | "file") | null;
+    subtype: "image" | "document" | "spreadsheet" | "video" | "audio" | "archive" | "other";
+    size: number | null;
+    contentType: string | null;
+    readonly: boolean | null;
+    hidden: boolean | null;
+    archivedAt: Date | null;
+    parentId: string | null;
+    assetId: string | null;
+  }[]>;
+  /**
+   * Lists paginated nodes with their linked storage asset.
+   *
+   * @example
+   * const result = await database.listNodesWithAsset({
+   *   limit: 20,
+   *   offset: 0,
+   *   filters: { namespace: "products", parentId: null },
+   *   sorts: [],
+   * });
+   */
+  listNodesWithAsset: ({ filters, limit, offset, sorts }: LocalDriveDatabaseListNodesWithAssetInput) => Promise<{
+    data: {
+      id: never;
+      createdAt: never;
+      updatedAt: never;
+      name: never;
+      namespace: never;
+      type: never;
+      subtype: never;
+      size: never;
+      contentType: never;
+      readonly: never;
+      hidden: never;
+      archivedAt: never;
+      parentId: never;
+      assetId: never;
+      asset: never;
+    }[];
+    total: number;
+  }>;
+  /**
+   * Resolves the ancestor chain for a folder or file within a namespace.
+   *
+   * @example
+   * const parents = await database.getNodeParents({ id: node.id, namespace: "products" });
+   */
+  getNodeParents: (input: {
+    id: string | null;
+    namespace: string;
+  }) => Promise<(Pick<LocalNode, "name" | "id" | "parentId"> & {
+    depth: number;
+  })[]>;
+  /**
+   * Resolves all recursive descendants for one or more nodes.
+   *
+   * @example
+   * const descendants = await database.getNodeChildren([folder.id]);
+   */
+  getNodeChildren: (ids: string[]) => Promise<LocalDriveDatabaseNodeChild[]>;
+  /**
+   * Creates a node row.
+   *
+   * @example
+   * const node = await database.createNode({
+   *   type: "file",
+   *   name: "manual.pdf",
+   *   namespace: "products",
+   *   subtype: "document",
+   *   assetId: asset.id,
+   * });
+   */
+  createNode: (input: LocalDriveDatabaseCreateNodeInput) => Promise<{
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    name: string;
+    namespace: string;
+    type: ("folder" | "file") | null;
+    subtype: "image" | "document" | "spreadsheet" | "video" | "audio" | "archive" | "other";
+    size: number | null;
+    contentType: string | null;
+    readonly: boolean | null;
+    hidden: boolean | null;
+    archivedAt: Date | null;
+    parentId: string | null;
+    assetId: string | null;
+  } | null>;
+  /**
+   * Updates a node row by primary id.
+   *
+   * @example
+   * const updated = await database.updateNodeById(node.id, { name: "Updated name" });
+   */
+  updateNodeById: (id: string, data: Partial<Pick<LocalNode, "name" | "size" | "contentType" | "readonly" | "hidden" | "archivedAt" | "parentId">>) => Promise<{
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    name: string;
+    namespace: string;
+    type: ("folder" | "file") | null;
+    subtype: "image" | "document" | "spreadsheet" | "video" | "audio" | "archive" | "other";
+    size: number | null;
+    contentType: string | null;
+    readonly: boolean | null;
+    hidden: boolean | null;
+    archivedAt: Date | null;
+    parentId: string | null;
+    assetId: string | null;
+  } | null>;
+  /**
+   * Updates nodes matching the provided filters.
+   *
+   * @example
+   * const [updated] = await database.updateNodes({
+   *   filters: { nodeIds: [node.id] },
+   *   data: { name: "Updated name" },
+   * });
+   */
+  updateNodes: ({ data, filters }: LocalDriveDatabaseUpdateNodesInput) => Promise<{
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    name: string;
+    namespace: string;
+    type: ("folder" | "file") | null;
+    subtype: "image" | "document" | "spreadsheet" | "video" | "audio" | "archive" | "other";
+    size: number | null;
+    contentType: string | null;
+    readonly: boolean | null;
+    hidden: boolean | null;
+    archivedAt: Date | null;
+    parentId: string | null;
+    assetId: string | null;
+  }[]>;
+  /**
+   * Deletes a node by primary id and relies on database cascades for dependent rows.
+   *
+   * @example
+   * await database.deleteNodeById(node.id);
+   */
+  deleteNodeById: (id: string) => Promise<void>;
+  /**
+   * Deletes nodes matching the provided filters.
+   *
+   * @example
+   * await database.deleteNodes({ filters: { nodeIds: [node.id] } });
+   */
+  deleteNodes: ({ filters }: LocalDriveDatabaseDeleteNodesInput) => Promise<void>;
+  /**
+   * Finds generated variants matching the provided filters.
+   *
+   * @example
+   * const variants = await database.findVariants({ filters: { nodeIds: [node.id] } });
+   */
+  findVariants: (input?: LocalDriveDatabaseFindVariantsInput | undefined) => Promise<{
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    nodeId: string;
+    assetId: string;
+    variant: "main" | `preview-${number}`;
+    width: number;
+  }[]>;
+  /**
+   * Records a generated image variant and its storage asset.
+   *
+   * @example
+   * await database.createVariant({
+   *   nodeId: node.id,
+   *   assetId: previewAsset.id,
+   *   variant: "preview-640",
+   *   width: 640,
+   * });
+   */
+  createVariant: (input: LocalDriveDatabaseCreateVariantInput) => Promise<void>;
+  /**
+   * Finds the first cached presigned URL matching the provided filters.
+   *
+   * @example
+   * const cached = await database.findFirstPresignedUrl({
+   *   filters: { nodeId: node.id, variant: "main", disposition: "inline" },
+   * });
+   */
+  findFirstPresignedUrl: (input: LocalDriveDatabaseFindFirstPresignedUrlInput | undefined) => Promise<{
+    url: string;
+    expiresAt: Date;
+  } | null>;
+  /**
+   * Creates or refreshes the cached presigned URL for a node variant.
+   *
+   * @example
+   * await database.upsertPresignedUrl({
+   *   nodeId: node.id,
+   *   variant: "main",
+   *   disposition: "attachment",
+   *   url,
+   *   expiresAt,
+   * });
+   */
+  upsertPresignedUrl: (input: UpsertLocalDrivePresignedUrlInput) => Promise<void>;
+};
+type LocalDriveDrizzleProvider<TSchema extends Record<string, unknown>, TDriveSchema extends LocalDriveDrizzleSchema = LocalDriveDrizzleSchema> = ReturnType<typeof localDriveDrizzleAdapter<TSchema, TDriveSchema>>;
+//#endregion
+export { LocalDriveDrizzleAdapterConfig, LocalDriveDrizzleProvider, localDriveDrizzleAdapter };