@_linked/s3 1.0.3 → 1.1.1

package/lib/cjs/shapes/S3Bucket.d.ts

@@ -1,80 +0,0 @@
-import { DeleteObjectCommandInput, S3Client } from '@aws-sdk/client-s3';
-import { PutObjectCommandInput, PutObjectCommandOutput } from '@aws-sdk/client-s3/dist-types/commands/PutObjectCommand';
-import { StreamingBlobPayloadInputTypes } from '@smithy/types';
-import { Shape } from '@_linked/core/shapes/Shape';
-export interface S3ClientConfigInput {
-    endpoint?: string;
-    accessKeyId?: string;
-    secretAccessKey?: string;
-    region?: string;
-}
-export declare const endpoint: string;
-/**
- * Builds an S3 client from explicit config, falling back to legacy env vars.
- * This enables multiple S3 stores in one process with independent credentials/endpoints.
- */
-export declare const createS3Client: (config?: S3ClientConfigInput) => S3Client;
-/**
- * Legacy singleton exported for backward compatibility. New code should prefer
- * per-instance clients by passing config into S3Bucket/S3FileStore.
- */
-export declare const s3Client: S3Client;
-export declare class S3Bucket extends Shape {
-    static targetClass: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    protected _client: S3Client;
-    label: string;
-    private ensureKeyPromise;
-    constructor(n?: string | {
-        id: string;
-    }, clientConfig?: S3ClientConfigInput);
-    get endpoint(): string;
-    /**
-     * Delete an object from the bucket.
-     * @param key The key of the object to delete
-     * @param options Additional options to pass to the DeleteObjectCommand
-     * @returns The response from the DeleteObjectCommand
-     * @todo Batch delete, see https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html
-     */
-    deleteObject(key: string, options?: Omit<DeleteObjectCommandInput, 'Key' | 'Bucket'>): Promise<import("@aws-sdk/client-s3").DeleteObjectCommandOutput>;
-    copyObject(sourceKey: string, destinationKey: string, options?: Omit<PutObjectCommandInput, 'Key' | 'Bucket'>): Promise<boolean>;
-    /**
-     * Put an object into the bucket.
-     *
-     * @param key The key of the object to PUT (i.e. file name)
-     * @param value The value of the object to PUT (i.e. file contents)
-     * @param options Additional options to pass to the PutObjectCommand
-     * @returns The response from the PutObjectCommand
-     */
-    putObject(key: string, value: StreamingBlobPayloadInputTypes, options?: Omit<PutObjectCommandInput, 'Body' | 'Key' | 'Bucket'>): Promise<PutObjectCommandOutput>;
-    /**
-     * Get a list of all object keys in the bucket.
-     * Important to note that only a maximum 1000 keys will be returned.
-     *
-     * @param prefix The prefix to search for in the bucket. This can be a folder or the beginning of a file name.
-     * @returns A list of all object keys in the bucket
-     * @todo Recursive search within directories
-     * @todo Implement pagination
-     */
-    getAllObjectKeys(prefix?: string): Promise<string[]>;
-    /**
-     * Get the contents of an object in the bucket.
-     * @param key The key of the object to get
-     * @returns The contents of the object as a string
-     */
-    getObject(key: string): Promise<string>;
-    /**
-     * Ensure that the given key exists in the bucket, the file contents
-     * will be an empty json object.
-     *
-     * @param key The key to insert if it does not exist
-     * @returns The promise that will resolve when the key exists
-     */
-    ensureKeyExists(key: string): Promise<string | void>;
-    private _ensureKeyExists;
-    private keyExists;
-    /**
-     * Create the bucket if it does not exist.
-     * @returns The promise that will resolve when the bucket exists
-     */
-    createBucket(): Promise<import("@aws-sdk/client-s3").CreateBucketCommandOutput>;
-}

package/lib/cjs/shapes/S3FileStore.d.ts

@@ -1,59 +0,0 @@
-import { IFileStore } from '@_linked/core/interfaces/IFileStore';
-import { Shape } from '@_linked/core/shapes/Shape';
-import { type S3ClientConfigInput } from './S3Bucket.js';
-import type { Readable } from 'stream';
-export interface S3FileStoreConfig {
-    bucketName?: string;
-    accessURL?: string;
-    prefix?: string;
-    clientConfig?: S3ClientConfigInput;
-}
-export declare class S3FileStore extends Shape implements IFileStore {
-    static targetClass: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    label: string;
-    private _bucket;
-    private readonly config;
-    readonly accessURL: string;
-    constructor(n: string | {
-        id: string;
-    }, config?: S3FileStoreConfig);
-    private get bucket();
-    private resolveBucketName;
-    private resolveAccessURL;
-    private get prefix();
-    private normalizePath;
-    private applyPrefix;
-    private stripPrefix;
-    /**
-     * List all files in the bucket
-     * @param recursive Whether to list files recursively or just the top-level files
-     * @returns A list of file paths, relative to the endpoint
-     * @todo Think about taking an options parameter instead of positional args
-     * @todo Take a path parameter to list files in a subdirectory
-     */
-    listFiles(prefix?: string): Promise<string[]>;
-    /**
-     * Save a file to the bucket
-     * @param filePath The path to save the file to, relative to the endpoint
-     * @param fileContent The contents of the file as a buffer
-     * @returns The public URL of the file
-     */
-    saveFile(filePath: string, fileContent: string | Uint8Array | Buffer | Readable, mimeType?: string, preventDuplicate?: boolean): Promise<string>;
-    /**
-     * Get a file from the bucket
-     * @param filePath The path of the file to get, relative to the endpoint
-     * @returns The contents of the file as a buffer
-     */
-    getFile(filePath: string): Promise<Buffer | null>;
-    /**
-     * Delete a file from the bucket
-     * @param filePath The path of the file to delete, relative to the endpoint
-     */
-    deleteFile(filePath: string): Promise<void>;
-    /**
-     * Check if a file exists in the bucket
-     * @param filePath The path of the file to check, relative to the endpoint
-     * @returns Whether the file exists
-     */
-    fileExists(filePath: string): Promise<boolean>;
-}

package/lib/cjs/types.d.ts

@@ -1,12 +0,0 @@
-declare module '*.module.css' {
-    const classes: {
-        [key: string]: string;
-    };
-    export default classes;
-}
-declare module '*.module.scss' {
-    const classes: {
-        [key: string]: string;
-    };
-    export default classes;
-}

package/lib/cjs/utils/accessUrl.d.ts

@@ -1,15 +0,0 @@
-/**
- * Access URL for user-uploaded files. This intentionally prefers upload-specific
- * env vars, then falls back to legacy shared env vars.
- */
-export declare const getAccessURLUploadsStore: () => string;
-/**
- * Access URL for static web assets (bundles/images/root). This can be independent
- * from uploads and is expected to include the release version when configured by
- * app storage bootstrap (for example ".../4.1.1").
- */
-export declare const getAccessURLStaticStore: () => string;
-/**
- * Backward-compatible alias for existing imports.
- */
-export declare const getAccessURLS3FileStore: () => string;

package/lib/esm/package.json

@@ -1,63 +0,0 @@
-{
-  "name": "@_linked/s3",
-  "displayName": "s3",
-  "description": "A general purpose Simple Storage Service (S3) package to be extended or used as is",
-  "author": {
-    "name": "Valentine Wilson",
-    "email": "valentine@semantu.com",
-    "url": "https://vw.codes"
-  },
-  "repository": {
-    "type": "git",
-    "url": ""
-  },
-  "version": "1.0.3",
-  "linkedPackage": true,
-  "license": "ISC",
-  "scripts": {
-    "start": "npm exec linked dev",
-    "build": "yarn linked build",
-    "prepublishOnly": "yarn linked build production",
-    "postpublish": "npm exec linked register"
-  },
-  "keywords": [
-    "lincd",
-    "linked data",
-    "interoperable",
-    "semantic web",
-    "web3",
-    "s3",
-    "simple storage service",
-    "cloud storage",
-    "aws"
-  ],
-  "dependencies": {
-    "@_linked/core": "^2.2.1",
-    "@_linked/server": "~1.0",
-    "@_linked/server-utils": "~1.0",
-    "@aws-sdk/client-s3": "^3.159.0",
-    "@aws-sdk/credential-providers": "^3.159.0",
-    "cron": "^3.1.7",
-    "mime": "2.6.0"
-  },
-  "devDependencies": {
-    "@_linked/cli": "^1.2",
-    "@changesets/changelog-github": "^0.5.2",
-    "@changesets/cli": "^2.29.8",
-    "@types/mime": "^3.0.4",
-    "tsconfig-to-dual-package": "^1.2.0",
-    "typescript": "^5.7.3",
-    "typescript-plugin-css-modules": "^5.1.0"
-  },
-  "typesVersions": {
-    "*": {
-      "*": [
-        "lib/esm/*"
-      ]
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "type": "module"
-}