@mediusinc/mng-commons-data-api 5.0.0-rc.0

package/openapi/param.mustache

@@ -0,0 +1,69 @@
+/**
+ * Standard parameter styles defined by OpenAPI spec
+ */
+export type StandardParamStyle =
+  | 'matrix'
+  | 'label'
+  | 'form'
+  | 'simple'
+  | 'spaceDelimited'
+  | 'pipeDelimited'
+  | 'deepObject'
+  ;
+
+/**
+ * The OpenAPI standard {@link StandardParamStyle}s may be extended by custom styles by the user.
+ */
+export type ParamStyle = StandardParamStyle | string;
+
+/**
+ * Standard parameter locations defined by OpenAPI spec
+ */
+export type ParamLocation = 'query' | 'header' | 'path' | 'cookie';
+
+/**
+ * Standard types as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a>
+ */
+export type StandardDataType =
+  | "integer"
+  | "number"
+  | "boolean"
+  | "string"
+  | "object"
+  | "array"
+  ;
+
+/**
+ * Standard {@link DataType}s plus your own types/classes.
+ */
+export type DataType = StandardDataType | string;
+
+/**
+ * Standard formats as defined in <a href="https://swagger.io/specification/#data-types">OpenAPI Specification: Data Types</a>
+ */
+export type StandardDataFormat =
+  | "int32"
+  | "int64"
+  | "float"
+  | "double"
+  | "byte"
+  | "binary"
+  | "date"
+  | "date-time"
+  | "password"
+  ;
+
+export type DataFormat = StandardDataFormat | string;
+
+/**
+ * The parameter to encode.
+ */
+export interface Param {
+  name: string;
+  value: unknown;
+  in: ParamLocation;
+  style: ParamStyle,
+  explode: boolean;
+  dataType: DataType;
+  dataFormat: DataFormat | undefined;
+}

package/openapi/tsconfig.mustache

@@ -0,0 +1,28 @@
+{
+    "compilerOptions": {
+        "emitDecoratorMetadata": true,
+        "experimentalDecorators": true,
+        "noImplicitAny": false,
+        "suppressImplicitAnyIndexErrors": true,
+        "target": "{{#supportsES6}}es6{{/supportsES6}}{{^supportsES6}}es5{{/supportsES6}}",
+        "module": "{{#supportsES6}}es6{{/supportsES6}}{{^supportsES6}}commonjs{{/supportsES6}}",
+        "moduleResolution": "node",
+        "removeComments": true,
+        "sourceMap": true,
+        "outDir": "./dist",
+        "noLib": false,
+        "declaration": true,
+        "lib": [ "es6", "dom" ],
+        "typeRoots": [
+            "node_modules/@types"
+        ]
+    },
+    "exclude": [
+        "node_modules",
+        "dist"
+    ],
+    "filesGlob": [
+        "./model/*.ts",
+        "./api/*.ts"
+    ]
+}

package/openapi/variables.mustache

@@ -0,0 +1,9 @@
+import { InjectionToken } from '@angular/core';
+
+export const BASE_PATH = new InjectionToken<string>('basePath');
+export const COLLECTION_FORMATS = {
+    'csv': ',',
+    'tsv': '   ',
+    'ssv': ' ',
+    'pipes': '|'
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@mediusinc/mng-commons-data-api",
+  "version": "5.0.0-rc.0",
+  "peerDependencies": {
+    "@angular/core": "^17.2.0",
+    "@mediusinc/mng-commons": "~5.0.0-rc.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "publishConfig": {
+    "directory": "dist"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/mediusinc-mng-commons-data-api.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/mediusinc-mng-commons-data-api.mjs",
+      "esm": "./esm2022/mediusinc-mng-commons-data-api.mjs",
+      "default": "./fesm2022/mediusinc-mng-commons-data-api.mjs"
+    },
+    "./tableview": {
+      "types": "./tableview/index.d.ts",
+      "esm2022": "./esm2022/tableview/mediusinc-mng-commons-data-api-tableview.mjs",
+      "esm": "./esm2022/tableview/mediusinc-mng-commons-data-api-tableview.mjs",
+      "default": "./fesm2022/mediusinc-mng-commons-data-api-tableview.mjs"
+    }
+  }
+}

package/tableview/README.md

@@ -0,0 +1,10 @@
+# @mediusinc/mng-commons-data-api/tableview
+
+Secondary entry point of `@mediusinc/mng-commons-data-api`. It can be used by importing from `@mediusinc/mng-commons-data-api/tableview`.
+
+## Dependencies within commons
+
+- `@mediusinc/mng-commons-data-api`
+- `@mediusinc/mng-commons/core`
+- `@mediusinc/mng-commons/model`
+- `@mediusinc/mng-commons/tableview/api`

package/tableview/index.d.ts

@@ -0,0 +1 @@
+export * from './tableview-get-all-params-create';

package/tableview/tableview-get-all-params-create.d.ts

@@ -0,0 +1,15 @@
+import { ExtractGetAllParamsFilterType, ExtractGetAllParamsSortType, GetAllParamsDefaultWoFiltersType } from '@mediusinc/mng-commons-data-api';
+import { ServiceClassType } from '@mediusinc/mng-commons/core';
+import { ModelDescriptor, TypeDescriptor } from '@mediusinc/mng-commons/model';
+import { TableviewDataProviderInst, TableviewDescriptorInst, TableviewInputBuilder } from '@mediusinc/mng-commons/tableview/api';
+/**
+ * Creates a tableview with a given model, service and sorts and filters extracted from Data API Get All request params, service, and optional build function.
+ *
+ * @param {ModelDescriptor<Model>} model - The model descriptor.
+ * @param {ServiceClassType<Service>} service - The class type of the service.
+ * @param {TypeDescriptor<RequestParam>} params - The request param of get all request. Filters and sorts will be taken from here.
+ * @param {(builder: TableviewBuilder) => void} [buildFn] - The optional callback function to customize the tableview using the prepared builder.
+ *
+ * @returns A tableview instance with descriptor, data provider and actions.
+ */
+export declare function tableviewWithGetAllParams<Model, Service, RequestParam extends GetAllParamsDefaultWoFiltersType, Sorts = ExtractGetAllParamsSortType<RequestParam>, Filters extends keyof any = ExtractGetAllParamsFilterType<RequestParam>>(model: ModelDescriptor<Model>, service: ServiceClassType<Service>, params: TypeDescriptor<RequestParam>, buildFn?: (builder: TableviewInputBuilder<Model, Service, TableviewDescriptorInst<Model, Sorts, Filters>, TableviewDataProviderInst<Model, Service, Sorts, Filters>, Sorts, Filters>) => void): import("@mediusinc/mng-commons/tableview/api").TableviewInput<Model, Service, Sorts, Filters, TableviewDescriptorInst<Model, Sorts, Filters>, TableviewDataProviderInst<Model, Service, Sorts, Filters, import("@mediusinc/mng-commons/core").ClassOptType<Model>, import("@mediusinc/mng-commons/core").ServiceClassOptType<Service>>>;