@capgo/capacitor-uploader 0.0.1

package/dist/docs.json

@@ -0,0 +1,310 @@
+{
+  "api": {
+    "name": "UploaderPlugin",
+    "slug": "uploaderplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "startUpload",
+        "signature": "(options: uploadOption) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "uploadOption"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "description",
+            "text": "Start the upload"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [
+          "uploadOption"
+        ],
+        "slug": "startupload"
+      },
+      {
+        "name": "removeUpload",
+        "signature": "(options: { id: string; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ id: string; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "description",
+            "text": "Remove the upload"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "removeupload"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'events', listenerFunc: (state: UploadEvent) => void) => any",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'events'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(state: UploadEvent) => void"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "description",
+            "text": "Add a listener for the upload events"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [
+          "UploadEvent",
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerevents-"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "uploadOption",
+      "slug": "uploadoption",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "filePath",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The file path of the file to upload",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "serverUrl",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The url of the server",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "notificationTitle",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "'Uploading'",
+              "name": "default"
+            },
+            {
+              "text": "The title of the notification\nAndroid only",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "headers",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The headers to send with the request",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "{ [key: string]: string; }"
+        },
+        {
+          "name": "method",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The method to use for the request",
+              "name": "description"
+            },
+            {
+              "text": "'POST'",
+              "name": "default"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'PUT' | 'POST' | undefined"
+        },
+        {
+          "name": "mimeType",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The mime type to use for the request",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "parameters",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The parameters to send with the request",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "{ [key: string]: string; } | undefined"
+        },
+        {
+          "name": "maxRetries",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The maximum number of retries",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "UploadEvent",
+      "slug": "uploadevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "name",
+          "tags": [],
+          "docs": "Current status of upload, between 0 and 100.",
+          "complexTypes": [],
+          "type": "'uploading' | 'completed' | 'failed'"
+        },
+        {
+          "name": "payload",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The payload of the event",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "{ percent?: number | undefined; error?: string | undefined; statusCode?: number | undefined; }"
+        },
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            },
+            {
+              "text": "The id of the upload",
+              "name": "description"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => any"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,92 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+export interface uploadOption {
+    /**
+     * @since 1.0.0
+     * @description The file path of the file to upload
+     */
+    filePath: string;
+    /**
+     * @since 1.0.0
+     * @description The url of the server
+     */
+    serverUrl: string;
+    /**
+     * @since 1.0.0
+     * @default 'Uploading'
+     * @description The title of the notification
+     * Android only
+     */
+    notificationTitle?: number;
+    /**
+     * @since 1.0.0
+     * @description The headers to send with the request
+     */
+    headers: {
+        [key: string]: string;
+    };
+    /**
+     * @since 1.0.0
+     * @description The method to use for the request
+     * @default 'POST'
+     */
+    method?: 'PUT' | 'POST';
+    /**
+     * @since 1.0.0
+     * @description The mime type to use for the request
+     */
+    mimeType?: string;
+    /**
+     * @since 1.0.0
+     * @description The parameters to send with the request
+     */
+    parameters?: {
+        [key: string]: string;
+    };
+    /**
+     * @since 1.0.0
+     * @description The maximum number of retries
+     */
+    maxRetries?: number;
+}
+export interface UploadEvent {
+    /**
+     * Current status of upload, between 0 and 100.
+     *
+     */
+    name: 'uploading' | 'completed' | 'failed';
+    /**
+     * @since 1.0.0
+     * @description The payload of the event
+     */
+    payload: {
+        percent?: number;
+        error?: string;
+        statusCode?: number;
+    };
+    /**
+     * @since 1.0.0
+     * @description The id of the upload
+     */
+    id: string;
+}
+export interface UploaderPlugin {
+    /**
+     * @since 1.0.0
+     * @description Start the upload
+     */
+    startUpload(options: uploadOption): Promise<{
+        id: string;
+    }>;
+    /**
+     * @since 1.0.0
+     * @description Remove the upload
+     */
+    removeUpload(options: {
+        id: string;
+    }): Promise<void>;
+    /**
+     * @since 1.0.0
+     * @description Add a listener for the upload events
+     */
+    addListener(eventName: 'events', listenerFunc: (state: UploadEvent) => void): Promise<PluginListenerHandle>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface uploadOption {\n  /**\n   * @since 1.0.0\n   * @description The file path of the file to upload\n   */\n  filePath: string;\n  /**\n   * @since 1.0.0\n   * @description The url of the server\n   */\n  serverUrl: string;\n  /**\n   * @since 1.0.0\n   * @default 'Uploading'\n   * @description The title of the notification\n   * Android only\n   */\n  notificationTitle?: number;\n  /**\n   * @since 1.0.0\n   * @description The headers to send with the request\n   */\n  headers: {\n    [key: string]: string;\n  };\n  /**\n   * @since 1.0.0\n   * @description The method to use for the request\n   * @default 'POST'\n   */\n  method?: 'PUT' | 'POST';\n  /**\n   * @since 1.0.0\n   * @description The mime type to use for the request\n   */\n  mimeType?: string;\n  /**\n   * @since 1.0.0\n   * @description The parameters to send with the request\n   */\n  parameters?: { [key: string]: string };\n  /**\n   * @since 1.0.0\n   * @description The maximum number of retries\n   */\n  maxRetries?: number;\n}\nexport interface UploadEvent {\n  /**\n   * Current status of upload, between 0 and 100.\n   *\n   */\n  name: 'uploading' | 'completed' | 'failed';\n  /**\n   * @since 1.0.0\n   * @description The payload of the event\n   */\n  payload: {\n    percent?: number;\n    error?: string;\n    statusCode?: number;\n  };\n  /**\n   * @since 1.0.0\n   * @description The id of the upload\n   */\n  id: string;\n}\n\nexport interface UploaderPlugin {\n  /**\n   * @since 1.0.0\n   * @description Start the upload\n   */\n  startUpload(options: uploadOption): Promise<{ id: string }>;\n  /**\n   * @since 1.0.0\n   * @description Remove the upload\n   */\n  removeUpload(options: { id: string }): Promise<void>;\n  /**\n   * @since 1.0.0\n   * @description Add a listener for the upload events\n   */\n  addListener(\n    eventName: 'events',\n    listenerFunc: (state: UploadEvent) => void,\n  ): Promise<PluginListenerHandle>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { UploaderPlugin } from './definitions';
+declare const Uploader: UploaderPlugin;
+export * from './definitions';
+export { Uploader };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const Uploader = registerPlugin('Uploader', {
+    web: () => import('./web').then(m => new m.UploaderWeb()),
+});
+export * from './definitions';
+export { Uploader };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,QAAQ,GAAG,cAAc,CAAiB,UAAU,EAAE;IAC1D,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;CAC1D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { UploaderPlugin } from './definitions';\n\nconst Uploader = registerPlugin<UploaderPlugin>('Uploader', {\n  web: () => import('./web').then(m => new m.UploaderWeb()),\n});\n\nexport * from './definitions';\nexport { Uploader };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,15 @@
+import { WebPlugin } from '@capacitor/core';
+import type { UploaderPlugin, uploadOption } from './definitions';
+export declare class UploaderWeb extends WebPlugin implements UploaderPlugin {
+    echo(options: {
+        value: string;
+    }): Promise<{
+        value: string;
+    }>;
+    startUpload(options: uploadOption): Promise<{
+        id: string;
+    }>;
+    removeUpload(options: {
+        id: string;
+    }): Promise<void>;
+}

package/dist/esm/web.js

@@ -0,0 +1,18 @@
+import { WebPlugin } from '@capacitor/core';
+export class UploaderWeb extends WebPlugin {
+    async echo(options) {
+        console.log('ECHO', options);
+        return options;
+    }
+    async startUpload(options) {
+        console.log('startUpload', options);
+        this.unimplemented('startUpload');
+        return { id: '123' };
+    }
+    async removeUpload(options) {
+        console.log('removeUpload', options);
+        this.unimplemented('removeUpload');
+        return;
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,WAAY,SAAQ,SAAS;IACxC,KAAK,CAAC,IAAI,CAAC,OAA0B;QACnC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC7B,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,KAAK,CAAC,WAAW,CAAC,OAAqB;QACrC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;QAClC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;IACvB,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,OAAuB;QACxC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACnC,OAAO;IACT,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { UploaderPlugin, uploadOption } from './definitions';\n\nexport class UploaderWeb extends WebPlugin implements UploaderPlugin {\n  async echo(options: { value: string }): Promise<{ value: string }> {\n    console.log('ECHO', options);\n    return options;\n  }\n  async startUpload(options: uploadOption): Promise<{ id: string }> {\n    console.log('startUpload', options);\n    this.unimplemented('startUpload');\n    return { id: '123' };\n  }\n  async removeUpload(options: { id: string }): Promise<void> {\n    console.log('removeUpload', options);\n    this.unimplemented('removeUpload');\n    return;\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,34 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@capacitor/core');
+
+const Uploader = core.registerPlugin('Uploader', {
+    web: () => Promise.resolve().then(function () { return web; }).then(m => new m.UploaderWeb()),
+});
+
+class UploaderWeb extends core.WebPlugin {
+    async echo(options) {
+        console.log('ECHO', options);
+        return options;
+    }
+    async startUpload(options) {
+        console.log('startUpload', options);
+        this.unimplemented('startUpload');
+        return { id: '123' };
+    }
+    async removeUpload(options) {
+        console.log('removeUpload', options);
+        this.unimplemented('removeUpload');
+        return;
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    UploaderWeb: UploaderWeb
+});
+
+exports.Uploader = Uploader;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst Uploader = registerPlugin('Uploader', {\n    web: () => import('./web').then(m => new m.UploaderWeb()),\n});\nexport * from './definitions';\nexport { Uploader };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class UploaderWeb extends WebPlugin {\n    async echo(options) {\n        console.log('ECHO', options);\n        return options;\n    }\n    async startUpload(options) {\n        console.log('startUpload', options);\n        this.unimplemented('startUpload');\n        return { id: '123' };\n    }\n    async removeUpload(options) {\n        console.log('removeUpload', options);\n        this.unimplemented('removeUpload');\n        return;\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;;;AACK,MAAC,QAAQ,GAAGA,mBAAc,CAAC,UAAU,EAAE;AAC5C,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;AAC7D,CAAC;;ACFM,MAAM,WAAW,SAASC,cAAS,CAAC;AAC3C,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE;AACxB,QAAQ,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACrC,QAAQ,OAAO,OAAO,CAAC;AACvB,KAAK;AACL,IAAI,MAAM,WAAW,CAAC,OAAO,EAAE;AAC/B,QAAQ,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;AAC5C,QAAQ,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;AAC1C,QAAQ,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;AAC7B,KAAK;AACL,IAAI,MAAM,YAAY,CAAC,OAAO,EAAE;AAChC,QAAQ,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AAC7C,QAAQ,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;AAC3C,QAAQ,OAAO;AACf,KAAK;AACL;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,37 @@
+var capacitorUploader = (function (exports, core) {
+    'use strict';
+
+    const Uploader = core.registerPlugin('Uploader', {
+        web: () => Promise.resolve().then(function () { return web; }).then(m => new m.UploaderWeb()),
+    });
+
+    class UploaderWeb extends core.WebPlugin {
+        async echo(options) {
+            console.log('ECHO', options);
+            return options;
+        }
+        async startUpload(options) {
+            console.log('startUpload', options);
+            this.unimplemented('startUpload');
+            return { id: '123' };
+        }
+        async removeUpload(options) {
+            console.log('removeUpload', options);
+            this.unimplemented('removeUpload');
+            return;
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        UploaderWeb: UploaderWeb
+    });
+
+    exports.Uploader = Uploader;
+
+    Object.defineProperty(exports, '__esModule', { value: true });
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst Uploader = registerPlugin('Uploader', {\n    web: () => import('./web').then(m => new m.UploaderWeb()),\n});\nexport * from './definitions';\nexport { Uploader };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class UploaderWeb extends WebPlugin {\n    async echo(options) {\n        console.log('ECHO', options);\n        return options;\n    }\n    async startUpload(options) {\n        console.log('startUpload', options);\n        this.unimplemented('startUpload');\n        return { id: '123' };\n    }\n    async removeUpload(options) {\n        console.log('removeUpload', options);\n        this.unimplemented('removeUpload');\n        return;\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,QAAQ,GAAGA,mBAAc,CAAC,UAAU,EAAE;IAC5C,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IAC7D,CAAC;;ICFM,MAAM,WAAW,SAASC,cAAS,CAAC;IAC3C,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE;IACxB,QAAQ,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,QAAQ,OAAO,OAAO,CAAC;IACvB,KAAK;IACL,IAAI,MAAM,WAAW,CAAC,OAAO,EAAE;IAC/B,QAAQ,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC5C,QAAQ,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IAC1C,QAAQ,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;IAC7B,KAAK;IACL,IAAI,MAAM,YAAY,CAAC,OAAO,EAAE;IAChC,QAAQ,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IAC7C,QAAQ,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAC3C,QAAQ,OAAO;IACf,KAAK;IACL;;;;;;;;;;;;;;;;;"}