grexx-api 1.0.2 → 12.6.6

package/dist/generated/core/OpenAPI.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAPI = void 0;
 exports.OpenAPI = {
-    BASE: 'https://daanpaardekooper-studio.local.grexx.io/api/v1',
-    VERSION: '12.6.1',
+    BASE: 'https://name.grexx.today/api/v1',
+    VERSION: '12.6.6',
     WITH_CREDENTIALS: false,
     CREDENTIALS: 'include',
     TOKEN: undefined,

package/dist/generated/core/request.d.ts

@@ -12,7 +12,7 @@ export declare const base64: (str: string) => string;
 export declare const getQueryString: (params: Record<string, any>) => string;
 export declare const getFormData: (options: ApiRequestOptions) => FormData | undefined;
 type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
-export declare const resolve: <T>(options: ApiRequestOptions, resolver?: T | Resolver<T> | undefined) => Promise<T | undefined>;
+export declare const resolve: <T>(options: ApiRequestOptions, resolver?: T | Resolver<T>) => Promise<T | undefined>;
 export declare const getHeaders: (config: OpenAPIConfig, options: ApiRequestOptions) => Promise<Headers>;
 export declare const getRequestBody: (options: ApiRequestOptions) => any;
 export declare const sendRequest: (config: OpenAPIConfig, options: ApiRequestOptions, url: string, body: any, formData: FormData | undefined, headers: Headers, onCancel: OnCancel) => Promise<Response>;

package/dist/generated/models/AdditionalAggregateColumn.js

@@ -7,4 +7,4 @@ var AdditionalAggregateColumn;
     (function (type) {
         type["AGGREGATED"] = "aggregated";
     })(type = AdditionalAggregateColumn.type || (AdditionalAggregateColumn.type = {}));
-})(AdditionalAggregateColumn = exports.AdditionalAggregateColumn || (exports.AdditionalAggregateColumn = {}));
+})(AdditionalAggregateColumn || (exports.AdditionalAggregateColumn = AdditionalAggregateColumn = {}));

package/dist/generated/models/AdditionalDataHistoryColumn.js

@@ -7,4 +7,4 @@ var AdditionalDataHistoryColumn;
     (function (type) {
         type["DATA_HISTORY"] = "dataHistory";
     })(type = AdditionalDataHistoryColumn.type || (AdditionalDataHistoryColumn.type = {}));
-})(AdditionalDataHistoryColumn = exports.AdditionalDataHistoryColumn || (exports.AdditionalDataHistoryColumn = {}));
+})(AdditionalDataHistoryColumn || (exports.AdditionalDataHistoryColumn = AdditionalDataHistoryColumn = {}));

package/dist/generated/models/AdditionalDerivedColumn.js

@@ -13,4 +13,4 @@ var AdditionalDerivedColumn;
     (function (type) {
         type["DERIVED"] = "derived";
     })(type = AdditionalDerivedColumn.type || (AdditionalDerivedColumn.type = {}));
-})(AdditionalDerivedColumn = exports.AdditionalDerivedColumn || (exports.AdditionalDerivedColumn = {}));
+})(AdditionalDerivedColumn || (exports.AdditionalDerivedColumn = AdditionalDerivedColumn = {}));

package/dist/generated/models/AdditionalExternalColumn.js

@@ -7,4 +7,4 @@ var AdditionalExternalColumn;
     (function (type) {
         type["EXTERNAL"] = "external";
     })(type = AdditionalExternalColumn.type || (AdditionalExternalColumn.type = {}));
-})(AdditionalExternalColumn = exports.AdditionalExternalColumn || (exports.AdditionalExternalColumn = {}));
+})(AdditionalExternalColumn || (exports.AdditionalExternalColumn = AdditionalExternalColumn = {}));

package/dist/generated/models/AdditionalGroupbyColumn.js

@@ -7,4 +7,4 @@ var AdditionalGroupbyColumn;
     (function (type) {
         type["GROUPBY"] = "groupby";
     })(type = AdditionalGroupbyColumn.type || (AdditionalGroupbyColumn.type = {}));
-})(AdditionalGroupbyColumn = exports.AdditionalGroupbyColumn || (exports.AdditionalGroupbyColumn = {}));
+})(AdditionalGroupbyColumn || (exports.AdditionalGroupbyColumn = AdditionalGroupbyColumn = {}));

package/dist/generated/models/AdditionalMetaColumn.js

@@ -24,4 +24,4 @@ var AdditionalMetaColumn;
     (function (type) {
         type["META"] = "meta";
     })(type = AdditionalMetaColumn.type || (AdditionalMetaColumn.type = {}));
-})(AdditionalMetaColumn = exports.AdditionalMetaColumn || (exports.AdditionalMetaColumn = {}));
+})(AdditionalMetaColumn || (exports.AdditionalMetaColumn = AdditionalMetaColumn = {}));

package/dist/generated/models/AdditionalTemplateColumn.js

@@ -7,4 +7,4 @@ var AdditionalTemplateColumn;
     (function (type) {
         type["TEMPLATE"] = "template";
     })(type = AdditionalTemplateColumn.type || (AdditionalTemplateColumn.type = {}));
-})(AdditionalTemplateColumn = exports.AdditionalTemplateColumn || (exports.AdditionalTemplateColumn = {}));
+})(AdditionalTemplateColumn || (exports.AdditionalTemplateColumn = AdditionalTemplateColumn = {}));

package/dist/generated/models/BaseMessage.js

@@ -11,4 +11,4 @@ var BaseMessage;
         level["ERROR"] = "ERROR";
         level["CRITICAL"] = "CRITICAL";
     })(level = BaseMessage.level || (BaseMessage.level = {}));
-})(BaseMessage = exports.BaseMessage || (exports.BaseMessage = {}));
+})(BaseMessage || (exports.BaseMessage = BaseMessage = {}));

package/dist/generated/models/CatchPattern.js

@@ -8,4 +8,4 @@ exports.CatchPattern = void 0;
 var CatchPattern;
 (function (CatchPattern) {
     CatchPattern["EMAIL_1001"] = "EMAIL-1001";
-})(CatchPattern = exports.CatchPattern || (exports.CatchPattern = {}));
+})(CatchPattern || (exports.CatchPattern = CatchPattern = {}));

package/dist/generated/models/ColumnIdentifier.js

@@ -11,4 +11,4 @@ var ColumnIdentifier;
     ColumnIdentifier["COLUMN_CASEID"] = "columnCaseid";
     ColumnIdentifier["EXTERNAL_REFERENCE"] = "externalReference";
     ColumnIdentifier["ALIAS"] = "alias";
-})(ColumnIdentifier = exports.ColumnIdentifier || (exports.ColumnIdentifier = {}));
+})(ColumnIdentifier || (exports.ColumnIdentifier = ColumnIdentifier = {}));

package/dist/generated/models/ConditionOperatorType.js

@@ -27,4 +27,4 @@ var ConditionOperatorType;
     ConditionOperatorType["NOTBEGINSWITH"] = "notbeginswith";
     ConditionOperatorType["ENDSWITH"] = "endswith";
     ConditionOperatorType["NOTENDSWITH"] = "notendswith";
-})(ConditionOperatorType = exports.ConditionOperatorType || (exports.ConditionOperatorType = {}));
+})(ConditionOperatorType || (exports.ConditionOperatorType = ConditionOperatorType = {}));

package/dist/generated/models/FieldType.js

@@ -17,4 +17,4 @@ var FieldType;
     FieldType["STATIC_PICKLIST_ITEM"] = "staticPicklistItem";
     FieldType["TASKDATA"] = "taskdata";
     FieldType["FORMFIELD"] = "formfield";
-})(FieldType = exports.FieldType || (exports.FieldType = {}));
+})(FieldType || (exports.FieldType = FieldType = {}));

package/dist/generated/models/FormFieldConditionList.js

@@ -7,4 +7,4 @@ var FormFieldConditionList;
     (function (listType) {
         listType["LIST"] = "list";
     })(listType = FormFieldConditionList.listType || (FormFieldConditionList.listType = {}));
-})(FormFieldConditionList = exports.FormFieldConditionList || (exports.FormFieldConditionList = {}));
+})(FormFieldConditionList || (exports.FormFieldConditionList = FormFieldConditionList = {}));

package/dist/generated/models/FormFieldSimpleCondition.js

@@ -7,4 +7,4 @@ var FormFieldSimpleCondition;
     (function (listType) {
         listType["SIMPLE"] = "simple";
     })(listType = FormFieldSimpleCondition.listType || (FormFieldSimpleCondition.listType = {}));
-})(FormFieldSimpleCondition = exports.FormFieldSimpleCondition || (exports.FormFieldSimpleCondition = {}));
+})(FormFieldSimpleCondition || (exports.FormFieldSimpleCondition = FormFieldSimpleCondition = {}));

package/dist/generated/models/InterfaceConditionListType.js

@@ -9,4 +9,4 @@ var InterfaceConditionListType;
 (function (InterfaceConditionListType) {
     InterfaceConditionListType["AND"] = "AND";
     InterfaceConditionListType["OR"] = "OR";
-})(InterfaceConditionListType = exports.InterfaceConditionListType || (exports.InterfaceConditionListType = {}));
+})(InterfaceConditionListType || (exports.InterfaceConditionListType = InterfaceConditionListType = {}));

package/dist/generated/models/PrimitiveType.js

@@ -36,4 +36,4 @@ var PrimitiveType;
     PrimitiveType["POINT2D"] = "point2d";
     PrimitiveType["POLYGON2D"] = "polygon2d";
     PrimitiveType["GREXXBLOB"] = "grexxblob";
-})(PrimitiveType = exports.PrimitiveType || (exports.PrimitiveType = {}));
+})(PrimitiveType || (exports.PrimitiveType = PrimitiveType = {}));

package/dist/generated/models/ReturnTypeFlags.js

@@ -8,4 +8,4 @@ var ReturnTypeFlags;
         multivalueType["SET"] = "set";
         multivalueType["LIST"] = "list";
     })(multivalueType = ReturnTypeFlags.multivalueType || (ReturnTypeFlags.multivalueType = {}));
-})(ReturnTypeFlags = exports.ReturnTypeFlags || (exports.ReturnTypeFlags = {}));
+})(ReturnTypeFlags || (exports.ReturnTypeFlags = ReturnTypeFlags = {}));

package/dist/generated/models/SortConfigSearchCondition.js

@@ -7,4 +7,4 @@ var SortConfigSearchCondition;
     (function (type) {
         type["SIMPLE_CONDITION"] = "simpleCondition";
     })(type = SortConfigSearchCondition.type || (SortConfigSearchCondition.type = {}));
-})(SortConfigSearchCondition = exports.SortConfigSearchCondition || (exports.SortConfigSearchCondition = {}));
+})(SortConfigSearchCondition || (exports.SortConfigSearchCondition = SortConfigSearchCondition = {}));

package/dist/generated/models/SortConfigSearchList.js

@@ -7,4 +7,4 @@ var SortConfigSearchList;
     (function (type) {
         type["CONDITION_LIST"] = "conditionList";
     })(type = SortConfigSearchList.type || (SortConfigSearchList.type = {}));
-})(SortConfigSearchList = exports.SortConfigSearchList || (exports.SortConfigSearchList = {}));
+})(SortConfigSearchList || (exports.SortConfigSearchList = SortConfigSearchList = {}));

package/dist/generated/models/SortConfigSort.js

@@ -8,4 +8,4 @@ var SortConfigSort;
         direction["ASC"] = "asc";
         direction["DESC"] = "desc";
     })(direction = SortConfigSort.direction || (SortConfigSort.direction = {}));
-})(SortConfigSort = exports.SortConfigSort || (exports.SortConfigSort = {}));
+})(SortConfigSort || (exports.SortConfigSort = SortConfigSort = {}));

package/dist/generated/services/CaseService.d.ts

@@ -93,13 +93,13 @@ export declare class CaseService {
     /**
      * Retrieve the contents of a form, rights are checked via form rights
      * @param casePath Path or Id of case
-     * @param form ID of form
-     * @param formId Set form
+     * @param formId ID of form
+     * @param form Set form
      * @param format Format of the result
      * @returns any Retrieve the contents of a form, rights are checked via form rights
      * @throws ApiError
      */
-    static formRetrieve(casePath: string, form: UnversionedReference, formId?: any, format?: 'simple' | 'extended' | 'full'): CancelablePromise<any>;
+    static formRetrieve(casePath: string, formId: UnversionedReference, form?: any, format?: 'simple' | 'extended' | 'full'): CancelablePromise<any>;
     /**
      * Retrieve the contents of a dataset, rights are checked via widget rights
      * @param casePath Path or Id of case
@@ -335,13 +335,13 @@ export declare class CaseService {
      * @deprecated
      * Retrieve the contents of a form, rights are checked via form rights
      * @param caseId ID of case
-     * @param form ID of form
-     * @param formId Set form
+     * @param formId ID of form
+     * @param form Set form
      * @param format Format of the result
      * @returns any Retrieve the contents of a form, rights are checked via form rights
      * @throws ApiError
      */
-    static formGet(caseId: UnversionedReference, form: UnversionedReference, formId?: any, format?: 'simple' | 'extended' | 'full'): CancelablePromise<any>;
+    static formGet(caseId: UnversionedReference, formId: UnversionedReference, form?: any, format?: 'simple' | 'extended' | 'full'): CancelablePromise<any>;
     /**
      * @deprecated
      * Retrieve the contents of a dataset, rights are checked via widget rights

package/dist/generated/services/CaseService.js

@@ -54,22 +54,22 @@ class CaseService {
     /**
      * Retrieve the contents of a form, rights are checked via form rights
      * @param casePath Path or Id of case
-     * @param form ID of form
-     * @param formId Set form
+     * @param formId ID of form
+     * @param form Set form
      * @param format Format of the result
      * @returns any Retrieve the contents of a form, rights are checked via form rights
      * @throws ApiError
      */
-    static formRetrieve(casePath, form, formId, format = 'simple') {
+    static formRetrieve(casePath, formId, form, format = 'simple') {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
-            url: '/form/{form}/{casePath}',
+            url: '/form/{formId}/{casePath}',
             path: {
                 'casePath': casePath,
-                'form': form,
+                'formId': formId,
             },
             query: {
-                'formId': formId,
+                'form': form,
                 'format': format,
             },
         });
@@ -238,22 +238,22 @@ class CaseService {
      * @deprecated
      * Retrieve the contents of a form, rights are checked via form rights
      * @param caseId ID of case
-     * @param form ID of form
-     * @param formId Set form
+     * @param formId ID of form
+     * @param form Set form
      * @param format Format of the result
      * @returns any Retrieve the contents of a form, rights are checked via form rights
      * @throws ApiError
      */
-    static formGet(caseId, form, formId, format = 'simple') {
+    static formGet(caseId, formId, form, format = 'simple') {
         return (0, request_1.request)(OpenAPI_1.OpenAPI, {
             method: 'GET',
-            url: '/case/{caseId}/form/{form}',
+            url: '/case/{caseId}/form/{formId}',
             path: {
                 'caseId': caseId,
-                'form': form,
+                'formId': formId,
             },
             query: {
-                'formId': formId,
+                'form': form,
                 'format': format,
             },
         });

package/generate-spec.ts

@@ -0,0 +1,17 @@
+import fs from 'fs';
+import yaml from 'js-yaml';
+import { OpenAPIGenerator } from '../src/server/utils/openapi-generator';
+
+const packageJSON = fs.readFileSync(__dirname + '/../package.json', 'utf8');
+const version = JSON.parse(packageJSON).version;
+
+// Ensure the version is always the same as our root project version
+const apiPackagePath = __dirname + '/package.json';
+const apiPackage = JSON.parse(fs.readFileSync(apiPackagePath, 'utf8'));
+fs.writeFileSync(__dirname + '/package.json', JSON.stringify({ ...apiPackage, version }, null, 2), 'utf8');
+
+const generator = new OpenAPIGenerator(version);
+
+const spec = generator.getSchema();
+fs.writeFileSync('./openapi-spec.yaml', yaml.dump(spec), 'utf8');
+console.log('OpenAPI spec saved to openapi-spec.yaml');

package/{openapi.yaml → openapi-spec.yaml}

@@ -5,7 +5,7 @@ info:
   contact:
     name: Grexx Platform Documentation
     url: https://docs.grexx.io/
-  version: 12.6.1
+  version: 12.6.6
 externalDocs:
   description: Read the documentation about the usage of this API
   url: https://docs.grexx.io/connect/api/
@@ -13,7 +13,7 @@ servers:
   - url: https://{hostname}/api/v1
     variables:
       hostname:
-        default: daanpaardekooper-studio.local.grexx.io
+        default: name.grexx.today
         description: The hostname for your Grexx platform.
 tags:
   - name: case
@@ -463,11 +463,11 @@ paths:
         Retrieve the contents of a dataset, rights are checked via dataset
         rights
       operationId: dataset-retrieve
-  /form/{form}/{casePath}:
+  /form/{formId}/{casePath}:
     get:
       parameters:
         - in: query
-          name: formId
+          name: form
           description: Set form
           required: false
           schema: {}
@@ -479,7 +479,7 @@ paths:
             type: string
         - in: path
           required: true
-          name: form
+          name: formId
           description: ID of form
           schema:
             $ref: '#/components/schemas/UnversionedReference'
@@ -1164,11 +1164,11 @@ paths:
         rights
       operationId: dataset-get
       deprecated: true
-  /case/{caseId}/form/{form}:
+  /case/{caseId}/form/{formId}:
     get:
       parameters:
         - in: query
-          name: formId
+          name: form
           description: Set form
           required: false
           schema: {}
@@ -1180,7 +1180,7 @@ paths:
             $ref: '#/components/schemas/UnversionedReference'
         - in: path
           required: true
-          name: form
+          name: formId
           description: ID of form
           schema:
             $ref: '#/components/schemas/UnversionedReference'
@@ -4467,4 +4467,4 @@ components:
         _ruleType:
           type: string
     MapStringObject:
-      type: object
+      type: object

package/package.json

@@ -1,18 +1,22 @@
 {
   "name": "grexx-api",
-  "version": "1.0.2",
-  "description": "",
+  "version": "12.6.6",
+  "description": "Grexx platform API javascript library",
   "main": "dist/generated/index.js",
   "types": "dist/generated/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "generate": "npx openapi-typescript-codegen --input openapi.yaml --output ./src/generated"
+    "generate": "ts-node ./generate-spec.ts && npx openapi-typescript-codegen --input openapi-spec.yaml --output ./src/generated",
+    "docs": "typedoc",
+    "build-and-publish": "npm run generate && npm run build && npm publish"
   },
   "devDependencies": {
     "openapi-typescript-codegen": "^0.29.0",
-    "typescript": "4.9.5"
-  },
-  "dependencies": {
-    "grexx-api": "^1.0.0"
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.27",
+    "typedoc-material-theme": "1.3",
+    "typedoc-plugin-merge-modules": "6",
+    "typedoc-plugin-rename-defaults": "0.7",
+    "typescript": "^5.8.3"
   }
-}
+}

package/tsconfig.json

@@ -3,6 +3,7 @@
     "target": "ESNext",
     "module": "commonjs",
     "strict": true,
+    "noImplicitAny": false,
     "esModuleInterop": true,
     "skipLibCheck": true,
     "outDir": "./dist",
@@ -11,4 +12,4 @@
   },
   "include": ["src/**/*.ts"],
   "exclude": ["node_modules"]
-}
+}

package/typedoc.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "name": "Grexx platform javascript library",
+  "entryPoints": ["src/generated/index.ts"],
+  "out": "docs",
+  "sidebarLinks": {
+    "JavaScript Browser API documentation": "/docs/api/js",
+    "Exit documentation": "/home"
+  },
+  "exclude": ["**/*.test.ts", "**/__tests__/**"],
+  "tsconfig": "tsconfig.json",
+  "plugin": ["typedoc-material-theme", "typedoc-plugin-rename-defaults", "typedoc-plugin-merge-modules"],
+  "themeColor": "#ffffff",
+  "excludeNotDocumented": true,
+  "excludeInternal": true,
+  "excludeReferences": true,
+  "includeVersion": true,
+  "excludeNotDocumentedKinds": ["Property", "Interface", "TypeAlias", "Namespace"]
+}

package/.idea/grexx-api.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/grexx-api.iml" filepath="$PROJECT_DIR$/.idea/grexx-api.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

package/openapitools.json

@@ -1,7 +0,0 @@
-{
-  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
-  "spaces": 2,
-  "generator-cli": {
-    "version": "7.12.0"
-  }
-}

package/src/generated/core/ApiError.ts

@@ -1,25 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { ApiRequestOptions } from './ApiRequestOptions';
-import type { ApiResult } from './ApiResult';
-
-export class ApiError extends Error {
-    public readonly url: string;
-    public readonly status: number;
-    public readonly statusText: string;
-    public readonly body: any;
-    public readonly request: ApiRequestOptions;
-
-    constructor(request: ApiRequestOptions, response: ApiResult, message: string) {
-        super(message);
-
-        this.name = 'ApiError';
-        this.url = response.url;
-        this.status = response.status;
-        this.statusText = response.statusText;
-        this.body = response.body;
-        this.request = request;
-    }
-}

package/src/generated/core/ApiRequestOptions.ts

@@ -1,17 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ApiRequestOptions = {
-    readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
-    readonly url: string;
-    readonly path?: Record<string, any>;
-    readonly cookies?: Record<string, any>;
-    readonly headers?: Record<string, any>;
-    readonly query?: Record<string, any>;
-    readonly formData?: Record<string, any>;
-    readonly body?: any;
-    readonly mediaType?: string;
-    readonly responseHeader?: string;
-    readonly errors?: Record<number, string>;
-};

package/src/generated/core/ApiResult.ts

@@ -1,11 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ApiResult = {
-    readonly url: string;
-    readonly ok: boolean;
-    readonly status: number;
-    readonly statusText: string;
-    readonly body: any;
-};