@thescaffold/jsx-blobs 0.0.0

package/README.md

@@ -0,0 +1,159 @@
+# Scaffold
+
+## JSX Blobs
+
+### Introduction
+
+This is the javascript SDK for scaffold platform. It covers APIs for the following services:
+
+- Events
+- Files
+- Forms
+- Jobs
+- Logs
+- Messages
+- Motion
+- Webhooks
+
+### Supported Platforms
+
+- Browser
+- Node.js (Javascript/Typescript)
+
+### Installation
+
+1. NPM
+
+```bash
+$ npm i @thescaffold/jsx-blobs
+```
+
+2. CDN
+
+```html
+
+```
+
+### Usage & API
+
+1. Initialization
+
+```ts
+import { init } from '@thescaffold/jsx-blobs';
+
+init({
+  // config
+});
+```
+
+2. Events
+
+- identify
+
+```ts
+import { events } from '@thescaffold/jsx-blobs';
+
+events.identify(id, payload, options);
+```
+
+- track
+
+```ts
+import { events } from '@thescaffold/jsx-blobs';
+
+events.track(id, payload, options);
+```
+
+3. Jobs
+
+- Schedule a new job
+
+```
+  import { jobs } from '@thescaffold/jsx-blobs'
+
+  jobs.schedule(id, payload, options)
+```
+
+4. Files
+
+- Upload file
+
+```
+  import { files } from '@thescaffold/jsx-blobs'
+
+  files.upload(name, files, options)
+```
+
+5. Forms
+
+- Submit form
+
+```
+  import { forms } from '@thescaffold/jsx-blobs'
+
+  forms.submit(name, payload, options)
+```
+
+6. Webhooks
+
+- register webhook
+
+```
+  import { webhooks } from '@thescaffold/jsx-blobs'
+
+
+  webhooks.register(name, payload, options)
+```
+
+7. Logs
+
+- identify
+
+```ts
+import { events } from '@thescaffold/jsx-blobs';
+
+events.identify(id, payload, options);
+```
+
+- track
+
+```ts
+import { events } from '@thescaffold/jsx-blobs';
+
+events.track(id, payload, options);
+```
+
+## Commands
+
+DTS scaffolds your new library inside `/src`.
+
+To run DTS, use:
+
+```bash
+npm start # or yarn start
+```
+
+This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+
+To do a one-off build, use `npm run build` or `yarn build`.
+
+To run tests, use `npm test` or `yarn test`.
+
+## Custom Commands
+
+```
+# build and sync locally
+$ node ./build --env=dev --sync=true
+
+# build and publish
+$ node ./build --env=prod --sync=true --version=x.x.x
+```
+
+## Publish
+
+```
+$ git tag <version e.g v0.0.0>
+$ git push origin <version>
+```
+
+## License

package/common/init/config.d.ts

@@ -0,0 +1,2 @@
+import { Config } from '../utils/values';
+export declare const getConfig: () => Config;

package/common/init/index.d.ts

@@ -0,0 +1,2 @@
+import { Config } from '../utils/values';
+export declare const init: (c: Config | any) => void;

package/common/queue/index.d.ts

@@ -0,0 +1,4 @@
+import { Item } from '../utils/values';
+export declare const push: (...items: Item[]) => void;
+export declare const pop: (length?: number) => Item[];
+export declare const length: () => number;

package/common/utils/functions.d.ts

@@ -0,0 +1,15 @@
+import { Config, LogType } from './values';
+export declare const isNode: () => boolean;
+export declare const isBrowser: () => boolean;
+export declare const isObject: (x: any) => boolean;
+export declare const recursiveMerge: (target: any, ...sources: any[]) => any;
+export declare const managedLog: (title: string, message: any, config: Config, ...types: LogType[]) => void;
+export declare const sleep: (ms: number) => Promise<unknown>;
+export declare const isFunction: (value: any) => boolean;
+export declare const streamFileChunks: (input: string | FileList, callback: (chunk: string, index: number) => void | Promise<void>, chunkSize?: number) => Promise<number>;
+export declare const streamFileChunksForNode: (path: string, callback: (chunk: string, index: number) => void | Promise<void>, chunkSize?: number) => Promise<number>;
+export declare const streamFileChunksForBrowser: (files: FileList, callback: (chunk: string, index: number) => void | Promise<void>, chunkSize?: number) => Promise<number>;
+export declare const getFileMeta: (input: string | FileList) => Promise<[string?, string?, number?, string?]>;
+export declare const getFileMetaForNode: (path: string) => Promise<[string?, string?, number?, string?]>;
+export declare const getFileMetaForBrowser: (files: FileList) => Promise<[string?, string?, number?, string?]>;
+export declare const uint8ToBase64: (bytes: Uint8Array) => string;

package/common/utils/values.d.ts

@@ -0,0 +1,109 @@
+export type Data = Record<string, any>;
+export declare enum CategoryType {
+    Form = "form",
+    File = "file",
+    Webhook = "webhook",
+    Job = "job",
+    Event = "event",
+    Log = "log",
+    Motion = "motion",
+    Message = "message",
+    Others = "others"
+}
+export declare enum LogType {
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error"
+}
+export interface Config {
+    /**
+     * Destination server base url
+     *
+     * Require
+     */
+    server: string;
+    /**
+     * Access token
+     */
+    credential: string;
+    /**
+     * SourceId
+     */
+    sourceId: string;
+    batch?: {
+        /**
+         * events and logs are sent to server in batches
+         * use interval to set the interval of flushing in mils
+         *
+         * Default to 5000mils
+         */
+        interval?: number;
+        /**
+         * The length of time to wait after a failure before retry
+         */
+        backoff?: number;
+        /**
+         * The number of retries before given up
+         *
+         * default to 3
+         */
+        limit?: number;
+    };
+    /**
+     * log display filter
+     */
+    logs?: LogType[];
+    debug?: boolean;
+}
+export interface BaseResponseBody {
+    status: 'success' | 'error' | string;
+    title: string;
+    message: string;
+    data?: any;
+    meta?: any;
+    raw?: string;
+    headers?: any;
+    [key: string]: any;
+}
+export interface BaseRequestBody {
+    [key: string]: any;
+}
+export interface BaseEntity {
+    id?: string;
+    createdAt?: string;
+    updateAt?: string;
+    deletedAt?: string;
+    [key: string]: any;
+}
+export interface BaseRequestQuery {
+    query?: string;
+    page?: number;
+    from?: string;
+    to?: string;
+    perPage?: number;
+    relations?: string;
+    columns?: string;
+    [key: string]: any;
+}
+export interface File {
+    type: string;
+    parentId?: string;
+    name: string;
+    tags?: string[];
+    size: number;
+    mime: string;
+    status?: string;
+    meta?: any;
+}
+export interface Page {
+    fileId: string;
+    index: number;
+    raw: string;
+    status?: string;
+    meta?: any;
+}
+export interface Item {
+    file: File;
+    pages: Page[];
+}
+export declare const mimeMap: Record<string, string>;

package/files/index.d.ts

@@ -0,0 +1,10 @@
+import { File, Page } from '../common/utils/values';
+export declare const init: (file: File) => Promise<any>;
+export declare const batch: (pages: Page[]) => Promise<any>;
+export declare const verify: (file: File) => Promise<any>;
+export declare const upload: (input: string | FileList, parentId?: string, tags?: string[]) => Promise<any[]>;
+/**
+ * return the full URL for the given file ID
+ * @param id
+ */
+export declare const download: (id: string) => string;

package/index.d.ts

@@ -0,0 +1,9 @@
+import { download, upload } from './files/index';
+/**
+ * Public APIs
+ */
+export { init } from './common/init/index';
+export * from './common/utils/values';
+export * from './platform/index';
+export * from './request/index';
+export { download, upload };

package/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./jsx-blobs.cjs.production.min.js')
+} else {
+  module.exports = require('./jsx-blobs.cjs.development.js')
+}