@peerbit/please-lib 0.0.3

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 dao.xyz
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/lib/esm/index.d.ts

@@ -0,0 +1,72 @@
+import { Program } from "@peerbit/program";
+import { Documents, Role } from "@peerbit/document";
+import { ProgramClient } from "@peerbit/program";
+declare abstract class AbstractFile {
+    abstract id: string;
+    abstract name: string;
+    abstract getFile(files: Files): Promise<Uint8Array | undefined>;
+}
+export declare class TinyFile extends AbstractFile {
+    id: string;
+    name: string;
+    file: Uint8Array;
+    constructor(properties: {
+        name: string;
+        file: Uint8Array;
+    });
+    getFile(_files: Files): Promise<Uint8Array>;
+}
+export declare class SmallFile extends AbstractFile {
+    id: string;
+    name: string;
+    cid: string;
+    constructor(properties: {
+        name: string;
+        cid: string;
+    });
+    static create(node: ProgramClient, name: string, file: Uint8Array): Promise<SmallFile>;
+    getFile(files: Files): Promise<Uint8Array | undefined>;
+}
+export declare class LargeFile extends AbstractFile {
+    id: string;
+    name: string;
+    fileIds: string[];
+    constructor(properties: {
+        id: string;
+        name: string;
+        fileIds: string[];
+    });
+    static create(name: string, file: Uint8Array, files: Files): Promise<LargeFile>;
+    getFile(files: Files): Promise<Uint8Array>;
+}
+type Args = {
+    role: Role;
+};
+export declare class Files extends Program<Args> {
+    id: Uint8Array;
+    files: Documents<AbstractFile>;
+    constructor(id?: Uint8Array);
+    create(name: string, file: Uint8Array): Promise<string>;
+    /**
+     * Get by name
+     * @param id
+     * @returns
+     */
+    getById(id: string): Promise<{
+        id: string;
+        name: string;
+        bytes: Uint8Array;
+    } | undefined>;
+    /**
+     * Get by name
+     * @param name
+     * @returns
+     */
+    getByName(name: string): Promise<{
+        id: string;
+        name: string;
+        bytes: Uint8Array;
+    } | undefined>;
+    open(args?: Args): Promise<void>;
+}
+export {};

package/lib/esm/index.js

@@ -0,0 +1,260 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var SmallFile_1, LargeFile_1;
+import { field, variant, vec } from "@dao-xyz/borsh";
+import { Program } from "@peerbit/program";
+import { Documents, SearchRequest, StringMatch } from "@peerbit/document";
+import { sha256Base64Sync, randomBytes } from "@peerbit/crypto";
+import { concat } from "uint8arrays";
+class AbstractFile {
+}
+const TINY_FILE_SIZE_LIMIT = 1e3;
+export let TinyFile = class TinyFile extends AbstractFile {
+    id;
+    name;
+    file; // 10 mb imit
+    constructor(properties) {
+        super();
+        this.id = sha256Base64Sync(properties.file);
+        this.name = properties.name;
+        this.file = properties.file;
+    }
+    async getFile(_files) {
+        if (sha256Base64Sync(this.file) !== this.id) {
+            throw new Error("Hash does not match the file content");
+        }
+        return Promise.resolve(this.file);
+    }
+};
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], TinyFile.prototype, "id", void 0);
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], TinyFile.prototype, "name", void 0);
+__decorate([
+    field({ type: Uint8Array }),
+    __metadata("design:type", Uint8Array)
+], TinyFile.prototype, "file", void 0);
+TinyFile = __decorate([
+    variant(0) // for versioning purposes
+    ,
+    __metadata("design:paramtypes", [Object])
+], TinyFile);
+const SMALL_FILE_SIZE_LIMIT = 1e6 * 9;
+export let SmallFile = SmallFile_1 = class SmallFile extends AbstractFile {
+    id; // cid
+    name;
+    cid; // store file separately in a block store, like IPFS
+    constructor(properties) {
+        super();
+        this.id = properties.cid;
+        this.name = properties.name;
+        this.cid = properties.cid;
+    }
+    static async create(node, name, file) {
+        if (file.length > SMALL_FILE_SIZE_LIMIT) {
+            throw new Error("To large file for SmallFile");
+        }
+        const cid = await node.services.blocks.put(file);
+        return new SmallFile_1({ name, cid });
+    }
+    async getFile(files) {
+        // Load the file from the block store
+        return await files.node.services.blocks.get(this.id);
+    }
+};
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], SmallFile.prototype, "id", void 0);
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], SmallFile.prototype, "name", void 0);
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], SmallFile.prototype, "cid", void 0);
+SmallFile = SmallFile_1 = __decorate([
+    variant(1) // for versioning purposes
+    ,
+    __metadata("design:paramtypes", [Object])
+], SmallFile);
+export let LargeFile = LargeFile_1 = class LargeFile extends AbstractFile {
+    id; // hash
+    name;
+    fileIds;
+    constructor(properties) {
+        super();
+        this.id = properties.id;
+        this.name = properties.name;
+        this.fileIds = properties.fileIds;
+    }
+    static async create(name, file, files) {
+        const segmetSize = SMALL_FILE_SIZE_LIMIT / 10; // 10% of the small size limit
+        const fileIds = [];
+        const id = sha256Base64Sync(file);
+        for (let i = 0; i < Math.ceil(file.byteLength / segmetSize); i++) {
+            fileIds.push(await files.create(id + "/" + name, file.subarray(i * segmetSize, Math.min((i + 1) * segmetSize, file.length))));
+        }
+        return new LargeFile_1({ id, name, fileIds });
+    }
+    async getFile(files) {
+        // Get all sub files (SmallFiles) and concatinate them in the right order (the order of this.fileIds)
+        const expectedIds = new Set(this.fileIds);
+        const chunks = new Map();
+        const results = await files.files.index.search(new SearchRequest({
+            query: [
+                new StringMatch({
+                    key: "name",
+                    value: this.id + "/" + this.name,
+                }),
+            ],
+        }), {
+            local: true,
+            remote: true,
+        });
+        if (results.length > 0) {
+            for (const r of results) {
+                if (chunks.has(r.id)) {
+                    // chunk already added;
+                }
+                if (!expectedIds.has(r.id)) {
+                    // chunk is not part of this file
+                }
+                chunks.set(r.id, r.getFile(files));
+            }
+        }
+        if (chunks.size !== expectedIds.size) {
+            throw new Error("Failed to resolve file");
+        }
+        const chunkContentResolved = await Promise.all(this.fileIds.map(async (x) => {
+            const chunkValue = await chunks.get(x);
+            if (!chunkValue) {
+                throw new Error("Failed to retrieve chunk with id: " + x);
+            }
+            return chunkValue;
+        }));
+        return concat(chunkContentResolved);
+    }
+};
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], LargeFile.prototype, "id", void 0);
+__decorate([
+    field({ type: "string" }),
+    __metadata("design:type", String)
+], LargeFile.prototype, "name", void 0);
+__decorate([
+    field({ type: vec("string") }),
+    __metadata("design:type", Array)
+], LargeFile.prototype, "fileIds", void 0);
+LargeFile = LargeFile_1 = __decorate([
+    variant(2) // for versioning purposes
+    ,
+    __metadata("design:paramtypes", [Object])
+], LargeFile);
+export let Files = class Files extends Program {
+    id;
+    files;
+    constructor(id = randomBytes(32)) {
+        super();
+        this.id = id;
+        this.files = new Documents({ id: this.id });
+    }
+    async create(name, file) {
+        let toPut;
+        if (file.byteLength <= TINY_FILE_SIZE_LIMIT) {
+            toPut = new TinyFile({ name, file });
+        }
+        else if (file.byteLength > TINY_FILE_SIZE_LIMIT &&
+            file.byteLength <= SMALL_FILE_SIZE_LIMIT) {
+            toPut = await SmallFile.create(this.node, name, file);
+        }
+        else {
+            toPut = await LargeFile.create(name, file, this);
+        }
+        await this.files.put(toPut);
+        return toPut.id;
+    }
+    /**
+     * Get by name
+     * @param id
+     * @returns
+     */
+    async getById(id) {
+        const results = await this.files.index.search(new SearchRequest({
+            query: [new StringMatch({ key: "id", value: id })],
+        }), {
+            local: true,
+            remote: {
+                timeout: 10 * 1000,
+            },
+        });
+        for (const result of results) {
+            const file = await result.getFile(this);
+            if (file) {
+                return { id: result.id, name: result.name, bytes: file };
+            }
+        }
+    }
+    /**
+     * Get by name
+     * @param name
+     * @returns
+     */
+    async getByName(name) {
+        const results = await this.files.index.search(new SearchRequest({
+            query: [new StringMatch({ key: "name", value: name })],
+        }), {
+            local: true,
+            remote: {
+                timeout: 10 * 1000,
+            },
+        });
+        for (const result of results) {
+            const file = await result.getFile(this);
+            if (file) {
+                return { id: result.id, name: result.name, bytes: file };
+            }
+        }
+    }
+    // Setup lifecycle, will be invoked on 'open'
+    async open(args) {
+        await this.files.open({
+            type: AbstractFile,
+            canAppend: async (entry) => {
+                await entry.verifySignatures();
+                return true; // no verification as of now
+            },
+            canRead: async (identity) => {
+                return true; // Anyone can query
+            },
+            role: args?.role,
+        });
+    }
+};
+__decorate([
+    field({ type: Uint8Array }),
+    __metadata("design:type", Uint8Array)
+], Files.prototype, "id", void 0);
+__decorate([
+    field({ type: Documents }),
+    __metadata("design:type", Documents)
+], Files.prototype, "files", void 0);
+Files = __decorate([
+    variant("files"),
+    __metadata("design:paramtypes", [Uint8Array])
+], Files);
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAQ,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEhE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAe,YAAY;CAI1B;AAED,MAAM,oBAAoB,GAAG,GAAG,CAAC;AAG1B,WAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,YAAY;IAEtC,EAAE,CAAS;IAGX,IAAI,CAAS;IAGb,IAAI,CAAa,CAAC,aAAa;IAE/B,YAAY,UAA8C;QACtD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,EAAE,GAAG,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAa;QACvB,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,EAAE,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SAC3D;QACD,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ,CAAA;AArBG;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;oCACf;AAGX;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;sCACb;AAGb;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;8BACtB,UAAU;sCAAC;AARR,QAAQ;IADpB,OAAO,CAAC,CAAC,CAAC,CAAC,0BAA0B;;;GACzB,QAAQ,CAuBpB;AAED,MAAM,qBAAqB,GAAG,GAAG,GAAG,CAAC,CAAC;AAG/B,WAAM,SAAS,iBAAf,MAAM,SAAU,SAAQ,YAAY;IAEvC,EAAE,CAAS,CAAC,MAAM;IAGlB,IAAI,CAAS;IAGb,GAAG,CAAS,CAAC,oDAAoD;IAEjE,YAAY,UAAyC;QACjD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAmB,EAAE,IAAY,EAAE,IAAgB;QACnE,IAAI,IAAI,CAAC,MAAM,GAAG,qBAAqB,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAClD;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjD,OAAO,IAAI,WAAS,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,KAAY;QACtB,qCAAqC;QACrC,OAAO,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACzD,CAAC;CACJ,CAAA;AA3BG;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;qCACf;AAGX;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;uCACb;AAGb;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;sCACd;AARH,SAAS;IADrB,OAAO,CAAC,CAAC,CAAC,CAAC,0BAA0B;;;GACzB,SAAS,CA6BrB;AAGM,WAAM,SAAS,iBAAf,MAAM,SAAU,SAAQ,YAAY;IAEvC,EAAE,CAAS,CAAC,OAAO;IAGnB,IAAI,CAAS;IAGb,OAAO,CAAW;IAElB,YAAY,UAA2D;QACnE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,IAAgB,EAAE,KAAY;QAC5D,MAAM,UAAU,GAAG,qBAAqB,GAAG,EAAE,CAAC,CAAC,8BAA8B;QAC7E,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,EAAE,CAAC,EAAE,EAAE;YAC9D,OAAO,CAAC,IAAI,CACR,MAAM,KAAK,CAAC,MAAM,CACd,EAAE,GAAG,GAAG,GAAG,IAAI,EACf,IAAI,CAAC,QAAQ,CACT,CAAC,GAAG,UAAU,EACd,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAC9C,CACJ,CACJ,CAAC;SACL;QAED,OAAO,IAAI,WAAS,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,KAAY;QACtB,qGAAqG;QACrG,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAiD,IAAI,GAAG,EAAE,CAAC;QAEvE,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAC1C,IAAI,aAAa,CAAC;YACd,KAAK,EAAE;gBACH,IAAI,WAAW,CAAC;oBACZ,GAAG,EAAE,MAAM;oBACX,KAAK,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI;iBACnC,CAAC;aACL;SACJ,CAAC,EACF;YACI,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI;SACf,CACJ,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE;gBACrB,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;oBAClB,uBAAuB;iBAC1B;gBACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;oBACxB,iCAAiC;iBACpC;gBAED,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;aACtC;SACJ;QAED,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC7C;QACD,MAAM,oBAAoB,GAAiB,MAAM,OAAO,CAAC,GAAG,CACxD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;YACzB,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACvC,IAAI,CAAC,UAAU,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,oCAAoC,GAAG,CAAC,CAAC,CAAC;aAC7D;YACD,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC,CACL,CAAC;QACF,OAAO,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;CACJ,CAAA;AAjFG;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;qCACf;AAGX;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;uCACb;AAGb;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;;0CACb;AART,SAAS;IADrB,OAAO,CAAC,CAAC,CAAC,CAAC,0BAA0B;;;GACzB,SAAS,CAmFrB;AAKM,WAAM,KAAK,GAAX,MAAM,KAAM,SAAQ,OAAa;IAEpC,EAAE,CAAa;IAGf,KAAK,CAA0B;IAE/B,YAAY,KAAiB,WAAW,CAAC,EAAE,CAAC;QACxC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,IAAI,SAAS,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,IAAgB;QACvC,IAAI,KAAmB,CAAC;QACxB,IAAI,IAAI,CAAC,UAAU,IAAI,oBAAoB,EAAE;YACzC,KAAK,GAAG,IAAI,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;SACxC;aAAM,IACH,IAAI,CAAC,UAAU,GAAG,oBAAoB;YACtC,IAAI,CAAC,UAAU,IAAI,qBAAqB,EAC1C;YACE,KAAK,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;SACzD;aAAM;YACH,KAAK,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;SACpD;QACD,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,KAAK,CAAC,EAAE,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CACT,EAAU;QAEV,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CACzC,IAAI,aAAa,CAAC;YACd,KAAK,EAAE,CAAC,IAAI,WAAW,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;SACrD,CAAC,EACF;YACI,KAAK,EAAE,IAAI;YACX,MAAM,EAAE;gBACJ,OAAO,EAAE,EAAE,GAAG,IAAI;aACrB;SACJ,CACJ,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC1B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACxC,IAAI,IAAI,EAAE;gBACN,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;aAC5D;SACJ;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CACX,IAAY;QAEZ,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CACzC,IAAI,aAAa,CAAC;YACd,KAAK,EAAE,CAAC,IAAI,WAAW,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;SACzD,CAAC,EACF;YACI,KAAK,EAAE,IAAI;YACX,MAAM,EAAE;gBACJ,OAAO,EAAE,EAAE,GAAG,IAAI;aACrB;SACJ,CACJ,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;YAC1B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACxC,IAAI,IAAI,EAAE;gBACN,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;aAC5D;SACJ;IACL,CAAC;IAED,6CAA6C;IAC7C,KAAK,CAAC,IAAI,CAAC,IAAW;QAClB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAClB,IAAI,EAAE,YAAY;YAClB,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;gBACvB,MAAM,KAAK,CAAC,gBAAgB,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC,CAAC,4BAA4B;YAC7C,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACxB,OAAO,IAAI,CAAC,CAAC,mBAAmB;YACpC,CAAC;YACD,IAAI,EAAE,IAAI,EAAE,IAAI;SACnB,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AAjGG;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;8BACxB,UAAU;iCAAC;AAGf;IADC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;8BACpB,SAAS;oCAAe;AALtB,KAAK;IADjB,OAAO,CAAC,OAAO,CAAC;qCAQG,UAAU;GAPjB,KAAK,CAmGjB"}

package/lib/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@peerbit/please-lib",
+    "version": "0.0.3",
+    "author": "dao.xyz",
+    "repository": "https://github.com/@dao-xyz/peerbit-examples",
+    "license": "Apache-2.0",
+    "type": "module",
+    "private": false,
+    "publishConfig": {
+        "access": "public"
+    },
+    "sideEffects": false,
+    "module": "lib/esm/index.js",
+    "types": "lib/esm/index.d.ts",
+    "exports": {
+        "import": "./lib/esm/index.js"
+    },
+    "files": [
+        "lib",
+        "src",
+        "src/nginx-template.conf",
+        "!src/**/__tests__",
+        "!lib/**/__tests__",
+        "LICENSE"
+    ],
+    "engines": {
+        "node": ">=16.0"
+    },
+    "scripts": {
+        "clean": "shx rm -rf lib/*",
+        "build": "yarn clean && tsc -p tsconfig.json",
+        "postbuild": "echo '{\"type\":\"module\"} ' | node ../../../node_modules/.bin/json > lib/esm/package.json",
+        "test": "node ../../../node_modules/.bin/jest test  -c  ../../../jest.config.ts --runInBand --forceExit",
+        "test:unit": "node ../../../node_modules/.bin/jest test  -c  ../../../jest.config.unit.ts --runInBand --forceExit",
+        "test:integration": "node ../../../node_modules/.bin/jest test -c  ../../../jest.config.integration.ts --runInBand --forceExit"
+    },
+    "devDependencies": {
+        "@peerbit/test-utils": "^1.0.12",
+        "peerbit": "^1.1.5",
+        "typescript": "^5.1.3"
+    },
+    "peerDependencies": {
+        "peerbit": "^1.1.5"
+    },
+    "gitHead": "f8266c28458441809aeeabaf2d686995ce05e707"
+}

package/src/index.ts

@@ -0,0 +1,264 @@
+import { field, variant, vec } from "@dao-xyz/borsh";
+import { Program } from "@peerbit/program";
+import { Documents, SearchRequest, StringMatch, Role } from "@peerbit/document";
+import { sha256Base64Sync, randomBytes } from "@peerbit/crypto";
+import { ProgramClient } from "@peerbit/program";
+import { concat } from "uint8arrays";
+
+abstract class AbstractFile {
+    abstract id: string;
+    abstract name: string;
+    abstract getFile(files: Files): Promise<Uint8Array | undefined>;
+}
+
+const TINY_FILE_SIZE_LIMIT = 1e3;
+
+@variant(0) // for versioning purposes
+export class TinyFile extends AbstractFile {
+    @field({ type: "string" })
+    id: string;
+
+    @field({ type: "string" })
+    name: string;
+
+    @field({ type: Uint8Array })
+    file: Uint8Array; // 10 mb imit
+
+    constructor(properties: { name: string; file: Uint8Array }) {
+        super();
+        this.id = sha256Base64Sync(properties.file);
+        this.name = properties.name;
+        this.file = properties.file;
+    }
+
+    async getFile(_files: Files) {
+        if (sha256Base64Sync(this.file) !== this.id) {
+            throw new Error("Hash does not match the file content");
+        }
+        return Promise.resolve(this.file);
+    }
+}
+
+const SMALL_FILE_SIZE_LIMIT = 1e6 * 9;
+
+@variant(1) // for versioning purposes
+export class SmallFile extends AbstractFile {
+    @field({ type: "string" })
+    id: string; // cid
+
+    @field({ type: "string" })
+    name: string;
+
+    @field({ type: "string" })
+    cid: string; // store file separately in a block store, like IPFS
+
+    constructor(properties: { name: string; cid: string }) {
+        super();
+        this.id = properties.cid;
+        this.name = properties.name;
+        this.cid = properties.cid;
+    }
+
+    static async create(node: ProgramClient, name: string, file: Uint8Array) {
+        if (file.length > SMALL_FILE_SIZE_LIMIT) {
+            throw new Error("To large file for SmallFile");
+        }
+        const cid = await node.services.blocks.put(file);
+        return new SmallFile({ name, cid });
+    }
+
+    async getFile(files: Files) {
+        // Load the file from the block store
+        return await files.node.services.blocks.get(this.id);
+    }
+}
+
+@variant(2) // for versioning purposes
+export class LargeFile extends AbstractFile {
+    @field({ type: "string" })
+    id: string; // hash
+
+    @field({ type: "string" })
+    name: string;
+
+    @field({ type: vec("string") })
+    fileIds: string[];
+
+    constructor(properties: { id: string; name: string; fileIds: string[] }) {
+        super();
+        this.id = properties.id;
+        this.name = properties.name;
+        this.fileIds = properties.fileIds;
+    }
+
+    static async create(name: string, file: Uint8Array, files: Files) {
+        const segmetSize = SMALL_FILE_SIZE_LIMIT / 10; // 10% of the small size limit
+        const fileIds: string[] = [];
+        const id = sha256Base64Sync(file);
+        for (let i = 0; i < Math.ceil(file.byteLength / segmetSize); i++) {
+            fileIds.push(
+                await files.create(
+                    id + "/" + name,
+                    file.subarray(
+                        i * segmetSize,
+                        Math.min((i + 1) * segmetSize, file.length)
+                    )
+                )
+            );
+        }
+
+        return new LargeFile({ id, name, fileIds });
+    }
+
+    async getFile(files: Files) {
+        // Get all sub files (SmallFiles) and concatinate them in the right order (the order of this.fileIds)
+        const expectedIds = new Set(this.fileIds);
+        const chunks: Map<string, Promise<Uint8Array | undefined>> = new Map();
+
+        const results = await files.files.index.search(
+            new SearchRequest({
+                query: [
+                    new StringMatch({
+                        key: "name",
+                        value: this.id + "/" + this.name,
+                    }),
+                ],
+            }),
+            {
+                local: true,
+                remote: true,
+            }
+        );
+
+        if (results.length > 0) {
+            for (const r of results) {
+                if (chunks.has(r.id)) {
+                    // chunk already added;
+                }
+                if (!expectedIds.has(r.id)) {
+                    // chunk is not part of this file
+                }
+
+                chunks.set(r.id, r.getFile(files));
+            }
+        }
+
+        if (chunks.size !== expectedIds.size) {
+            throw new Error("Failed to resolve file");
+        }
+        const chunkContentResolved: Uint8Array[] = await Promise.all(
+            this.fileIds.map(async (x) => {
+                const chunkValue = await chunks.get(x);
+                if (!chunkValue) {
+                    throw new Error("Failed to retrieve chunk with id: " + x);
+                }
+                return chunkValue;
+            })
+        );
+        return concat(chunkContentResolved);
+    }
+}
+
+type Args = { role: Role };
+
+@variant("files")
+export class Files extends Program<Args> {
+    @field({ type: Uint8Array })
+    id: Uint8Array;
+
+    @field({ type: Documents })
+    files: Documents<AbstractFile>;
+
+    constructor(id: Uint8Array = randomBytes(32)) {
+        super();
+        this.id = id;
+        this.files = new Documents({ id: this.id });
+    }
+
+    async create(name: string, file: Uint8Array) {
+        let toPut: AbstractFile;
+        if (file.byteLength <= TINY_FILE_SIZE_LIMIT) {
+            toPut = new TinyFile({ name, file });
+        } else if (
+            file.byteLength > TINY_FILE_SIZE_LIMIT &&
+            file.byteLength <= SMALL_FILE_SIZE_LIMIT
+        ) {
+            toPut = await SmallFile.create(this.node, name, file);
+        } else {
+            toPut = await LargeFile.create(name, file, this);
+        }
+        await this.files.put(toPut);
+        return toPut.id;
+    }
+
+    /**
+     * Get by name
+     * @param id
+     * @returns
+     */
+    async getById(
+        id: string
+    ): Promise<{ id: string; name: string; bytes: Uint8Array } | undefined> {
+        const results = await this.files.index.search(
+            new SearchRequest({
+                query: [new StringMatch({ key: "id", value: id })],
+            }),
+            {
+                local: true,
+                remote: {
+                    timeout: 10 * 1000,
+                },
+            }
+        );
+
+        for (const result of results) {
+            const file = await result.getFile(this);
+            if (file) {
+                return { id: result.id, name: result.name, bytes: file };
+            }
+        }
+    }
+
+    /**
+     * Get by name
+     * @param name
+     * @returns
+     */
+    async getByName(
+        name: string
+    ): Promise<{ id: string; name: string; bytes: Uint8Array } | undefined> {
+        const results = await this.files.index.search(
+            new SearchRequest({
+                query: [new StringMatch({ key: "name", value: name })],
+            }),
+            {
+                local: true,
+                remote: {
+                    timeout: 10 * 1000,
+                },
+            }
+        );
+
+        for (const result of results) {
+            const file = await result.getFile(this);
+            if (file) {
+                return { id: result.id, name: result.name, bytes: file };
+            }
+        }
+    }
+
+    // Setup lifecycle, will be invoked on 'open'
+    async open(args?: Args): Promise<void> {
+        await this.files.open({
+            type: AbstractFile,
+            canAppend: async (entry) => {
+                await entry.verifySignatures();
+                return true; // no verification as of now
+            },
+            canRead: async (identity) => {
+                return true; // Anyone can query
+            },
+            role: args?.role,
+        });
+    }
+}