@thescaffold/jsx-flags 0.0.10

package/README.md

@@ -0,0 +1,148 @@
+# Scaffold
+
+## JSX Flags
+
+### Introduction
+
+### Supported Platforms
+
+- Browser
+- Node.js (Javascript/Typescript)
+
+### Installation
+
+1. NPM
+
+```bash
+$ npm i @thescaffold/jsx-flags
+```
+
+2. CDN
+
+```html
+
+```
+
+### Usage & API
+
+1. Initialization
+
+```ts
+import { init } from '@thescaffold/jsx-flags';
+
+init({
+  // config
+});
+```
+
+2. Events
+
+- identify
+
+```ts
+import { events } from '@thescaffold/jsx-flags';
+
+events.identify(id, payload, options);
+```
+
+- track
+
+```ts
+import { events } from '@thescaffold/jsx-flags';
+
+events.track(id, payload, options);
+```
+
+3. Jobs
+
+- Schedule a new job
+
+```
+  import { jobs } from '@thescaffold/jsx-flags'
+
+  jobs.schedule(id, payload, options)
+```
+
+4. Files
+
+- Upload file
+
+```
+  import { files } from '@thescaffold/jsx-flags'
+
+  files.upload(name, files, options)
+```
+
+5. Forms
+
+- Submit form
+
+```
+  import { forms } from '@thescaffold/jsx-flags'
+
+  forms.submit(name, payload, options)
+```
+
+6. Webhooks
+
+- register webhook
+
+```
+  import { webhooks } from '@thescaffold/jsx-flags'
+
+
+  webhooks.register(name, payload, options)
+```
+
+7. Logs
+
+- identify
+
+```ts
+import { events } from '@thescaffold/jsx-flags';
+
+events.identify(id, payload, options);
+```
+
+- track
+
+```ts
+import { events } from '@thescaffold/jsx-flags';
+
+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/utils/functions.d.ts

@@ -0,0 +1,10 @@
+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 isString: (value: any) => boolean;
+export declare const arrayDepth: (value: any) => number;

package/common/utils/values.d.ts

@@ -0,0 +1,77 @@
+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;
+    /**
+     * 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 Flag {
+    name: string;
+    limit: number;
+    priority: number;
+    level: string;
+    reference?: string;
+    meta?: any;
+    status?: string;
+}

package/flag/index.d.ts

@@ -0,0 +1,9 @@
+import { Flag } from '../common/utils/values';
+export declare const register: (flags: Flag[], environmentTypeName?: string) => Promise<boolean | null>;
+export declare const log: (name: string, limit?: number, level?: string, userId?: string, clientId?: string, workspaceId?: string) => Promise<boolean | null>;
+export declare const status: (names: any, level?: string, userId?: string, clientId?: string, workspaceId?: string) => Promise<boolean | null>;
+export declare const limit: (name: string, level?: string, userId?: string, clientId?: string, workspaceId?: string) => Promise<{
+    allowed: boolean;
+    limit: number;
+    usage: number;
+} | null>;

package/index.d.ts

@@ -0,0 +1,8 @@
+import { limit, log, register, status } from './flag/index';
+/**
+ * Public APIs
+ */
+export { init } from './common/init/index';
+export * from './common/utils/values';
+export * from './request/index';
+export { limit, log, register, status };

package/index.js

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