@_linked/s3 1.0.2 → 1.1.0

package/lib/esm/shapes/S3FileStore.js

@@ -0,0 +1,173 @@
+import { Shape } from '@_linked/core/shapes/Shape';
+import mime from 'mime';
+import path from 'path';
+import { s3 } from '../ontologies/s3.js';
+import { S3Bucket } from './S3Bucket.js';
+const trimSlashes = (value = '') => value.replace(/^\/+|\/+$/g, '');
+const trimTrailingSlash = (value = '') => value.replace(/\/+$/g, '');
+export class S3FileStore extends Shape {
+    constructor(n, config = {}) {
+        if (typeof n === 'string') {
+            //set a fixed URI. This is important because the URI needs to match on the frontend and backend
+            super(`${process.env.DATA_ROOT}/s3-filestore/${n}`);
+            this.label = n;
+        }
+        else {
+            super(n);
+        }
+        this.config = config;
+        this.accessURL = this.resolveAccessURL();
+    }
+    get bucket() {
+        const bucketName = this.resolveBucketName();
+        if (!bucketName) {
+            throw new Error('S3_FILES_BUCKET_NAME environment variable must be set to use S3FileStore (or pass bucketName in config)');
+        }
+        if (!this._bucket) {
+            this._bucket = new S3Bucket(bucketName, this.config.clientConfig);
+        }
+        return this._bucket;
+    }
+    resolveBucketName() {
+        var _a, _b, _c;
+        // Scoped store config wins. Legacy shared env vars stay as fallback to keep
+        // existing apps working while allowing upload/static separation.
+        return ((_c = (_b = (_a = this.config.bucketName) !== null && _a !== void 0 ? _a : process.env.S3_FILES_BUCKET_NAME) !== null && _b !== void 0 ? _b : process.env.UPLOADS_S3_FILES_BUCKET_NAME) !== null && _c !== void 0 ? _c : process.env.STATIC_S3_FILES_BUCKET_NAME);
+    }
+    resolveAccessURL() {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const explicitAccessURL = (_c = (_b = (_a = this.config.accessURL) !== null && _a !== void 0 ? _a : process.env.S3_CDN_URL) !== null && _b !== void 0 ? _b : process.env.UPLOADS_ACCESS_URL) !== null && _c !== void 0 ? _c : process.env.STATIC_ACCESS_URL;
+        if (explicitAccessURL) {
+            return trimTrailingSlash(explicitAccessURL);
+        }
+        const endpoint = (_g = (_f = (_e = (_d = this.config.clientConfig) === null || _d === void 0 ? void 0 : _d.endpoint) !== null && _e !== void 0 ? _e : process.env.S3_BUCKET_ENDPOINT) !== null && _f !== void 0 ? _f : process.env.UPLOADS_S3_BUCKET_ENDPOINT) !== null && _g !== void 0 ? _g : process.env.STATIC_S3_BUCKET_ENDPOINT;
+        const bucketName = this.resolveBucketName();
+        if (endpoint && bucketName) {
+            return `${trimTrailingSlash(endpoint)}/${bucketName}`;
+        }
+        return trimTrailingSlash(endpoint);
+    }
+    get prefix() {
+        var _a;
+        // Optional per-store key prefix, used for versioned static publishing.
+        return trimSlashes((_a = this.config.prefix) !== null && _a !== void 0 ? _a : '');
+    }
+    normalizePath(filePath) {
+        return filePath.replace(/^\/+/, '');
+    }
+    applyPrefix(filePath) {
+        const normalizedPath = this.normalizePath(filePath);
+        if (!this.prefix) {
+            return normalizedPath;
+        }
+        // Guard against accidental double prefixing when callers pass already-prefixed keys.
+        if (normalizedPath.startsWith(`${this.prefix}/`)) {
+            return normalizedPath;
+        }
+        return `${this.prefix}/${normalizedPath}`;
+    }
+    stripPrefix(filePath) {
+        if (!this.prefix) {
+            return filePath;
+        }
+        const normalizedPath = this.normalizePath(filePath);
+        const prefixedPath = `${this.prefix}/`;
+        if (normalizedPath.startsWith(prefixedPath)) {
+            return normalizedPath.substring(prefixedPath.length);
+        }
+        return normalizedPath;
+    }
+    /**
+     * 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
+     */
+    async listFiles(prefix) {
+        let bucket = this.bucket;
+        const keyPrefix = this.prefix
+            ? prefix
+                ? this.applyPrefix(prefix)
+                : `${this.prefix}/`
+            : prefix;
+        return bucket
+            .getAllObjectKeys(keyPrefix)
+            .then((keys) => keys.map((key) => this.stripPrefix(key)))
+            .catch((err) => {
+            console.error('Error listing files:', err);
+            return [];
+        });
+    }
+    /**
+     * 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
+     */
+    async saveFile(filePath, fileContent, mimeType, preventDuplicate = false) {
+        let bucket = this.bucket;
+        filePath = this.normalizePath(filePath);
+        if (!mimeType) {
+            mimeType = mime.getType(filePath);
+        }
+        // console.log(`mimeType of ${filePath} is ${mimeType}`);
+        //first check if the object already exists
+        if (preventDuplicate && (await this.fileExists(filePath))) {
+            //if yes, use a more unique name based on the current unix timestamp
+            filePath = `${path.dirname(filePath)}/${Date.now()}-${path.basename(filePath)}`;
+            console.log('File already exists, renaming to avoid overwrite: ' + filePath);
+        }
+        const key = this.applyPrefix(filePath);
+        let res = await bucket
+            .putObject(key, fileContent, {
+            ContentType: mimeType,
+        })
+            .catch((err) => {
+            console.error('Error saving file to S3:', err);
+            return false;
+        });
+        if (!res) {
+            return null;
+        }
+        return this.accessURL + '/' + filePath;
+    }
+    /**
+     * 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
+     */
+    async getFile(filePath) {
+        let bucket = this.bucket;
+        const key = this.applyPrefix(filePath);
+        const bufferString = await bucket.getObject(key);
+        return Buffer.from(bufferString, 'base64');
+    }
+    /**
+     * Delete a file from the bucket
+     * @param filePath The path of the file to delete, relative to the endpoint
+     */
+    async deleteFile(filePath) {
+        let bucket = this.bucket;
+        await bucket.deleteObject(this.applyPrefix(filePath));
+    }
+    /**
+     * 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
+     */
+    async fileExists(filePath) {
+        try {
+            const bucket = await this.bucket.getObject(this.applyPrefix(filePath));
+            if (!bucket) {
+                return false;
+            }
+            return true;
+        }
+        catch (e) {
+            return false;
+        }
+    }
+}
+S3FileStore.targetClass = s3.FileStore;
+//# sourceMappingURL=S3FileStore.js.map

package/lib/esm/shapes/S3FileStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3FileStore.js","sourceRoot":"","sources":["../../../src/shapes/S3FileStore.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,EAAE,EAAE,MAAM,qBAAqB,CAAC;AACzC,OAAO,EAAE,QAAQ,EAA4B,MAAM,eAAe,CAAC;AAUnE,MAAM,WAAW,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AACpE,MAAM,iBAAiB,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AAErE,MAAM,OAAO,WAAY,SAAQ,KAAK;IASpC,YAAY,CAA0B,EAAE,SAA4B,EAAE;QACpE,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC1B,+FAA+F;YAC/F,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,iBAAiB,CAAC,EAAE,CAAC,CAAC;YACpD,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,CAAC,CAAC,CAAC;QACX,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC3C,CAAC;IAED,IAAY,MAAM;QAChB,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC5C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,yGAAyG,CAC1G,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,iBAAiB;;QACvB,4EAA4E;QAC5E,iEAAiE;QACjE,OAAO,CACL,MAAA,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,UAAU,mCACtB,OAAO,CAAC,GAAG,CAAC,oBAAoB,mCAChC,OAAO,CAAC,GAAG,CAAC,4BAA4B,mCACxC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CACxC,CAAC;IACJ,CAAC;IAEO,gBAAgB;;QACtB,MAAM,iBAAiB,GACrB,MAAA,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,SAAS,mCACrB,OAAO,CAAC,GAAG,CAAC,UAAU,mCACtB,OAAO,CAAC,GAAG,CAAC,kBAAkB,mCAC9B,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QAEhC,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GACZ,MAAA,MAAA,MAAA,MAAA,IAAI,CAAC,MAAM,CAAC,YAAY,0CAAE,QAAQ,mCAClC,OAAO,CAAC,GAAG,CAAC,kBAAkB,mCAC9B,OAAO,CAAC,GAAG,CAAC,0BAA0B,mCACtC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAE5C,IAAI,QAAQ,IAAI,UAAU,EAAE,CAAC;YAC3B,OAAO,GAAG,iBAAiB,CAAC,QAAQ,CAAC,IAAI,UAAU,EAAE,CAAC;QACxD,CAAC;QAED,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,IAAY,MAAM;;QAChB,uEAAuE;QACvE,OAAO,WAAW,CAAC,MAAA,IAAI,CAAC,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAEO,aAAa,CAAC,QAAgB;QACpC,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAEO,WAAW,CAAC,QAAgB;QAClC,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,qFAAqF;QACrF,IAAI,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjD,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,MAAM,IAAI,cAAc,EAAE,CAAC;IAC5C,CAAC;IAEO,WAAW,CAAC,QAAgB;QAClC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,YAAY,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC;QACvC,IAAI,cAAc,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAC5C,OAAO,cAAc,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CAAC,MAAe;QAC7B,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM;YAC3B,CAAC,CAAC,MAAM;gBACN,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;gBAC1B,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG;YACrB,CAAC,CAAC,MAAM,CAAC;QAEX,OAAO,MAAM;aACV,gBAAgB,CAAC,SAAS,CAAC;aAC3B,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;aACxD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAC;YAC3C,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,QAAgB,EAChB,WAAoD,EACpD,QAAiB,EACjB,mBAA4B,KAAK;QAEjC,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAEzB,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAExC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACpC,CAAC;QACD,yDAAyD;QAEzD,0CAA0C;QAC1C,IAAI,gBAAgB,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC1D,oEAAoE;YACpE,QAAQ,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,QAAQ,CACjE,QAAQ,CACT,EAAE,CAAC;YACJ,OAAO,CAAC,GAAG,CACT,oDAAoD,GAAG,QAAQ,CAChE,CAAC;QACJ,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,GAAG,GAAG,MAAM,MAAM;aACnB,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE;YAC3B,WAAW,EAAE,QAAQ;SACtB,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAC;YAC/C,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,GAAG,GAAG,GAAG,QAAQ,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,QAAgB;QAC5B,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAEzB,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAEjD,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,QAAgB;QAC/B,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAEzB,MAAM,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,QAAgB;QAC/B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;YACvE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;;AAxNM,uBAAW,GAAG,EAAE,CAAC,SAAS,CAAC"}

package/lib/esm/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/lib/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/lib/esm/utils/accessUrl.js

@@ -0,0 +1,93 @@
+const trimTrailingSlash = (value = '') => value.replace(/\/+$/g, '');
+const trimSlashes = (value = '') => value.replace(/^\/+|\/+$/g, '');
+/**
+ * Read env vars in a browser-safe way while still allowing webpack EnvironmentPlugin
+ * to inline direct `process.env.X` references at build time.
+ */
+const readEnv = (getter) => {
+    try {
+        return getter();
+    }
+    catch (_error) {
+        return undefined;
+    }
+};
+// Shared legacy env set used when scoped STATIC_/UPLOADS_ vars are absent.
+const getSharedS3Env = () => ({
+    accessURL: readEnv(() => process.env.S3_CDN_URL),
+    endpoint: readEnv(() => process.env.S3_BUCKET_ENDPOINT),
+    bucketName: readEnv(() => process.env.S3_FILES_BUCKET_NAME),
+});
+// Returns the first defined, non-empty value from a fallback chain.
+const firstNonEmpty = (...values) => {
+    for (const value of values) {
+        if (value !== undefined && value !== null && value !== '') {
+            return value;
+        }
+    }
+    return undefined;
+};
+// Builds versioned/static URL segments without duplicate or broken slashes.
+const appendPathSegment = (base, segment) => {
+    const cleanBase = trimTrailingSlash(base || '');
+    const cleanSegment = trimSlashes(segment || '');
+    if (!cleanBase) {
+        return undefined;
+    }
+    if (!cleanSegment || cleanBase.endsWith(`/${cleanSegment}`)) {
+        return cleanBase;
+    }
+    return `${cleanBase}/${cleanSegment}`;
+};
+// Normalizes the final public access URL from either direct accessURL or endpoint+bucket.
+const getAccessURL = ({ accessURL, endpoint, bucketName, }) => {
+    if (accessURL) {
+        return trimTrailingSlash(accessURL);
+    }
+    if (endpoint && bucketName) {
+        return `${trimTrailingSlash(endpoint)}/${bucketName}`;
+    }
+    return trimTrailingSlash(endpoint);
+};
+/**
+ * Access URL for user-uploaded files. This intentionally prefers upload-specific
+ * env vars, then falls back to legacy shared env vars.
+ */
+export const getAccessURLUploadsStore = () => {
+    const shared = getSharedS3Env();
+    const uploadsAccessURL = readEnv(() => process.env.UPLOADS_ACCESS_URL);
+    const uploadsEndpoint = readEnv(() => process.env.UPLOADS_S3_BUCKET_ENDPOINT);
+    const uploadsBucketName = readEnv(() => process.env.UPLOADS_S3_FILES_BUCKET_NAME);
+    return getAccessURL({
+        accessURL: firstNonEmpty(uploadsAccessURL, shared.accessURL),
+        endpoint: firstNonEmpty(uploadsEndpoint, shared.endpoint),
+        bucketName: firstNonEmpty(uploadsBucketName, shared.bucketName),
+    });
+};
+/**
+ * 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 const getAccessURLStaticStore = () => {
+    const shared = getSharedS3Env();
+    const uploadsEndpoint = readEnv(() => process.env.UPLOADS_S3_BUCKET_ENDPOINT);
+    const uploadsBucketName = readEnv(() => process.env.UPLOADS_S3_FILES_BUCKET_NAME);
+    const staticAccessURL = readEnv(() => process.env.STATIC_ACCESS_URL);
+    const version = readEnv(() => process.env.VERSION);
+    const staticEndpoint = readEnv(() => process.env.STATIC_S3_BUCKET_ENDPOINT);
+    const staticBucketName = readEnv(() => process.env.STATIC_S3_FILES_BUCKET_NAME);
+    // If STATIC_ACCESS_URL is not set, derive it from shared CDN + VERSION.
+    // This keeps static assets versioned even with legacy env-only configs.
+    const fallbackStaticAccessURL = appendPathSegment(shared.accessURL, version);
+    return getAccessURL({
+        accessURL: firstNonEmpty(staticAccessURL, fallbackStaticAccessURL),
+        endpoint: firstNonEmpty(staticEndpoint, uploadsEndpoint, shared.endpoint),
+        bucketName: firstNonEmpty(staticBucketName, uploadsBucketName, shared.bucketName),
+    });
+};
+/**
+ * Backward-compatible alias for existing imports.
+ */
+export const getAccessURLS3FileStore = () => getAccessURLUploadsStore();
+//# sourceMappingURL=accessUrl.js.map

package/lib/esm/utils/accessUrl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessUrl.js","sourceRoot":"","sources":["../../../src/utils/accessUrl.ts"],"names":[],"mappings":"AAAA,MAAM,iBAAiB,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AACrE,MAAM,WAAW,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,GAAG,CAAC,MAAgC,EAAE,EAAE;IACnD,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,CAAC;IAClB,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF,2EAA2E;AAC3E,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;IAChD,QAAQ,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IACvD,UAAU,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;CAC5D,CAAC,CAAC;AAEH,oEAAoE;AACpE,MAAM,aAAa,GAAG,CAAC,GAAG,MAAiC,EAAE,EAAE;IAC7D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YAC1D,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,4EAA4E;AAC5E,MAAM,iBAAiB,GAAG,CAAC,IAAa,EAAE,OAAgB,EAAE,EAAE;IAC5D,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAChD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,YAAY,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,YAAY,EAAE,CAAC,EAAE,CAAC;QAC5D,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,SAAS,IAAI,YAAY,EAAE,CAAC;AACxC,CAAC,CAAC;AAEF,0FAA0F;AAC1F,MAAM,YAAY,GAAG,CAAC,EACpB,SAAS,EACT,QAAQ,EACR,UAAU,GAKX,EAAE,EAAE;IACH,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,QAAQ,IAAI,UAAU,EAAE,CAAC;QAC3B,OAAO,GAAG,iBAAiB,CAAC,QAAQ,CAAC,IAAI,UAAU,EAAE,CAAC;IACxD,CAAC;IACD,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,EAAE;IAC3C,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;IAChC,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC9E,MAAM,iBAAiB,GAAG,OAAO,CAC/B,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAC/C,CAAC;IAEF,OAAO,YAAY,CAAC;QAClB,SAAS,EAAE,aAAa,CAAC,gBAAgB,EAAE,MAAM,CAAC,SAAS,CAAC;QAC5D,QAAQ,EAAE,aAAa,CAAC,eAAe,EAAE,MAAM,CAAC,QAAQ,CAAC;QACzD,UAAU,EAAE,aAAa,CAAC,iBAAiB,EAAE,MAAM,CAAC,UAAU,CAAC;KAChE,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE;IAC1C,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;IAChC,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC9E,MAAM,iBAAiB,GAAG,OAAO,CAC/B,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAC/C,CAAC;IACF,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrE,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnD,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC5E,MAAM,gBAAgB,GAAG,OAAO,CAC9B,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAC9C,CAAC;IACF,wEAAwE;IACxE,wEAAwE;IACxE,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAE7E,OAAO,YAAY,CAAC;QAClB,SAAS,EAAE,aAAa,CAAC,eAAe,EAAE,uBAAuB,CAAC;QAClE,QAAQ,EAAE,aAAa,CAAC,cAAc,EAAE,eAAe,EAAE,MAAM,CAAC,QAAQ,CAAC;QACzE,UAAU,EAAE,aAAa,CACvB,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,CAAC,UAAU,CAClB;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE,CAAC,wBAAwB,EAAE,CAAC"}

package/package.json

@@ -11,16 +11,17 @@
     "type": "git",
     "url": ""
   },
-  "version": "1.0.2",
+  "version": "1.1.0",
   "linkedPackage": true,
-  "main": "lib/cjs/index.js",
-  "types": "dist/s3.d.ts",
+  "type": "module",
+  "main": "lib/esm/index.js",
+  "types": "./lib/esm/index.d.ts",
   "license": "ISC",
   "scripts": {
     "start": "npm exec linked dev",
-    "build": "yarn linked build",
-    "prepublishOnly": "yarn linked build production",
-    "postpublish": "npm exec linked register"
+    "build": "rimraf ./lib && yarn build-esm && yarn copy-to-lib",
+    "build-esm": "echo \"compiling ESM\" && rimraf ./lib/esm && (yarn tsc -p tsconfig-esm.json || echo 'tsc returned non-zero; .js still emitted via noEmitOnError default')",
+    "copy-to-lib": "echo 'copying JSON assets to lib folder' && yarn copyfiles -u 1 'src/**/*.json' lib/esm"
   },
   "keywords": [
     "lincd",
@@ -35,8 +36,8 @@
   ],
   "dependencies": {
     "@_linked/core": "^2.2.1",
-    "@_linked/server": "~1.0",
-    "@_linked/server-utils": "~1.0",
+    "@_linked/server": "^2.0.0",
+    "@_linked/server-utils": "^1.0",
     "@aws-sdk/client-s3": "^3.159.0",
     "@aws-sdk/credential-providers": "^3.159.0",
     "cron": "^3.1.7",
@@ -44,29 +45,28 @@
   },
   "devDependencies": {
     "@_linked/cli": "^1.2",
+    "@changesets/changelog-github": "^0.5.2",
+    "@changesets/cli": "^2.29.8",
     "@types/mime": "^3.0.4",
+    "copyfiles": "^2.4.1",
+    "rimraf": "^5.0.7",
     "tsconfig-to-dual-package": "^1.2.0",
     "typescript": "^5.7.3",
-    "typescript-plugin-css-modules": "^5.1.0",
-    "@changesets/cli": "^2.29.8",
-    "@changesets/changelog-github": "^0.5.2"
+    "typescript-plugin-css-modules": "^5.1.0"
   },
   "module": "lib/esm/index.js",
   "exports": {
     ".": {
       "types": "./lib/esm/index.d.ts",
-      "import": "./lib/esm/index.js",
-      "require": "./lib/cjs/index.js"
+      "import": "./lib/esm/index.js"
     },
     "./*.js": {
       "types": "./lib/esm/*.d.ts",
-      "import": "./lib/esm/*.js",
-      "require": "./lib/cjs/*.js"
+      "import": "./lib/esm/*.js"
     },
     "./*": {
       "types": "./lib/esm/*.d.ts",
-      "import": "./lib/esm/*.js",
-      "require": "./lib/cjs/*.js"
+      "import": "./lib/esm/*.js"
     }
   },
   "typesVersions": {

package/tsconfig-esm.json

@@ -4,6 +4,6 @@
     "module": "esnext",
     "target": "es2018",
     "outDir": "lib/esm",
-    "moduleResolution": "node"
+    "moduleResolution": "bundler"
   }
 }

package/lib/cjs/data/s3.json

@@ -1,20 +0,0 @@
-{
-  "@context": {
-    "dc": "http://purl.org/dc/elements/1.1/",
-    "owl": "http://www.w3.org/2002/07/owl#",
-    "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
-    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
-    "s3": "http://lincd.org/ont/s3/"
-  },
-  "@graph": [
-    {
-      "@id": "s3:ExampleClass",
-      "@type": "rdfs:Class",
-      "rdfs:comment": "This is an example class. You can remove or rename it",
-      "rdfs:isDefinedBy": {
-        "@id": "s3:"
-      },
-      "rdfs:label": "Example Class"
-    }
-  ]
-}

package/lib/cjs/index.d.ts

@@ -1,5 +0,0 @@
-import './types.js';
-import './ontologies/s3.js';
-import './shapes/S3Bucket.js';
-import './shapes/S3FileStore.js';
-import './utils/accessUrl.js';

package/lib/cjs/ontologies/s3.d.ts

@@ -1,38 +0,0 @@
-export declare var loadData: () => Promise<{
-    "@context": {
-        dc: string;
-        owl: string;
-        rdf: string;
-        rdfs: string;
-        s3: string;
-    };
-    "@graph": {
-        "@id": string;
-        "@type": string;
-        "rdfs:comment": string;
-        "rdfs:isDefinedBy": {
-            "@id": string;
-        };
-        "rdfs:label": string;
-    }[];
-}>;
-export declare var ns: (term: string) => import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var _self: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var Bucket: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var FileStore: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var FrontendStore: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var QuadStore: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var bucket: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var endpoint: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var key: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare var secret: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-export declare const s3: {
-    Bucket: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    FileStore: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    FrontendStore: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    QuadStore: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    bucket: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    endpoint: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    key: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-    secret: import("@_linked/core/utils/NodeReference.js").NodeReferenceValue;
-};

package/lib/cjs/package.d.ts

@@ -1,4 +0,0 @@
-export declare const linkedShape: {
-    <T extends typeof import("@_linked/core/shapes/Shape").Shape>(constructor: T): void;
-    <T extends typeof import("@_linked/core/shapes/Shape").Shape>(config?: import("@_linked/core/utils/Package").ShapeConfig): (constructor: T) => void;
-}, linkedUtil: (constructor: any) => any, linkedOntology: (allFileExports: any, nameSpace: (term: string) => import("@_linked/core/utils/NodeReference").NodeReferenceValue, suggestedPrefixAndFileName: string, loadDataFunction?: () => Promise<any>, dataSource?: string | string[]) => void, registerPackageExport: (exportedObject: any) => void, packageExports: any, packageName: string;

package/lib/cjs/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.2",
-  "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",
-    "@types/mime": "^3.0.4",
-    "tsconfig-to-dual-package": "^1.2.0",
-    "typescript": "^5.7.3",
-    "typescript-plugin-css-modules": "^5.1.0",
-    "@changesets/cli": "^2.29.8",
-    "@changesets/changelog-github": "^0.5.2"
-  },
-  "typesVersions": {
-    "*": {
-      "*": [
-        "lib/esm/*"
-      ]
-    }
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "type": "commonjs"
-}

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>;
-}