@pgds/api-interface 1.6.1 → 1.6.3

package/api/schemas/productTypes/customization/updateOrganizationIdSchema.d.ts

@@ -0,0 +1,15 @@
+export declare const UpdateOrganizationIdRequestBodySchema: {
+    type: string;
+    properties: {
+        thingIds: {
+            type: string;
+            items: {
+                type: string;
+            };
+        };
+        newOrganizationId: {
+            type: string;
+        };
+    };
+    required: string[];
+};

package/api/schemas/productTypes/customization/upsertProductTypeCustomizationSchema.d.ts

@@ -0,0 +1,68 @@
+export declare const upsertProductTypeCustomizationSchema: {
+    type: string;
+    oneOf: ({
+        properties: {
+            organizationId: {
+                type: string;
+            };
+            customization: {
+                type: string;
+                properties: {
+                    name: {
+                        type: string[];
+                        minLength: number;
+                    };
+                    heartbeat: {
+                        type: string;
+                        properties: {
+                            interval: {
+                                type: string[];
+                                default: number;
+                            };
+                            timeout: {
+                                type: string[];
+                                default: number;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            thingId?: undefined;
+        };
+        required: string[];
+        additionalProperties: boolean;
+    } | {
+        properties: {
+            thingId: {
+                type: string;
+            };
+            organizationId: {
+                type: string;
+            };
+            customization: {
+                type: string;
+                properties: {
+                    heartbeat: {
+                        type: string;
+                        properties: {
+                            interval: {
+                                type: string[];
+                                default: number;
+                            };
+                            timeout: {
+                                type: string[];
+                                default: number;
+                            };
+                        };
+                        additionalProperties: boolean;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+        };
+        required: string[];
+        additionalProperties: boolean;
+    })[];
+};

package/api/schemas/productTypes/productTypesSchemasShared.d.ts

@@ -0,0 +1,84 @@
+export declare const heartbeat: {
+    type: string;
+    properties: {
+        interval: {
+            type: string[];
+            default: number;
+        };
+        timeout: {
+            type: string[];
+            default: number;
+        };
+    };
+    additionalProperties: boolean;
+};
+export declare const productTypeShareIdSchema: {
+    type: string;
+    properties: {
+        shareId: {
+            type: string;
+            minLength: number;
+        };
+        productTypeId: {
+            type: string;
+            minLength: number;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};
+export declare const productTypeIdSchema: {
+    type: string;
+    properties: {
+        productTypeId: {
+            type: string;
+            minLength: number;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+};
+export declare const thingCustomization: {
+    type: string;
+    properties: {
+        heartbeat: {
+            type: string;
+            properties: {
+                interval: {
+                    type: string[];
+                    default: number;
+                };
+                timeout: {
+                    type: string[];
+                    default: number;
+                };
+            };
+            additionalProperties: boolean;
+        };
+    };
+    additionalProperties: boolean;
+};
+export declare const organizationCustomization: {
+    type: string;
+    properties: {
+        name: {
+            type: string[];
+            minLength: number;
+        };
+        heartbeat: {
+            type: string;
+            properties: {
+                interval: {
+                    type: string[];
+                    default: number;
+                };
+                timeout: {
+                    type: string[];
+                    default: number;
+                };
+            };
+            additionalProperties: boolean;
+        };
+    };
+    additionalProperties: boolean;
+};

package/api/schemas/productTypes/updateCapabilitiesSchema.d.ts

@@ -0,0 +1,344 @@
+import { CapabilityCanBeTriggeredBy, CapabilityType } from "../../../constants/constants";
+declare enum SupportedDerivedValues {
+    AbsoluteHumidity = "absoluteHumidity",
+    MixingRatio = "mixingRatio",
+    DewPoint = "dewPoint",
+    SpecificHumidity = "specificHumidity",
+    Wme = "wme"
+}
+export declare const updateCapabilitiesSchema: {
+    type: string;
+    items: {
+        oneOf: ({
+            type: string;
+            properties: {
+                name: {
+                    type: string;
+                    minLength: number;
+                    description: string;
+                };
+                v1_datafieldName: {
+                    type: string;
+                    description: string;
+                };
+                type: {
+                    type: string;
+                    enum: CapabilityType[];
+                };
+                metadata: {
+                    type: string;
+                    description: string;
+                    properties: {
+                        unit: {
+                            type: string;
+                            description: string;
+                        };
+                        thingPage: {
+                            type: string;
+                            properties: {
+                                statusBar: {
+                                    type: string;
+                                    description: string;
+                                };
+                                graph: {
+                                    type: string;
+                                    description: string;
+                                };
+                                stateIndicator: {
+                                    type: string;
+                                    description: string;
+                                    oneOf: {
+                                        type: string;
+                                        properties: {
+                                            type: {
+                                                type: string;
+                                                enum: string[];
+                                            };
+                                            thresholds: {
+                                                type: string;
+                                                items: {
+                                                    type: string;
+                                                };
+                                                minItems: number;
+                                                maxItems: number;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: boolean;
+                                    }[];
+                                };
+                            };
+                            additionalProperties: boolean;
+                        };
+                        enum: {
+                            type: string;
+                            patternProperties: {
+                                "^-?\\d+$": {
+                                    type: string;
+                                    minProperties: number;
+                                    description: string;
+                                    additionalProperties: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                            additionalProperties: boolean;
+                        };
+                    };
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        } | {
+            type: string;
+            properties: {
+                name: {
+                    type: string;
+                    minLength: number;
+                    description: string;
+                };
+                type: {
+                    type: string;
+                    enum: CapabilityType[];
+                };
+                metadata: {
+                    type: string;
+                    description: string;
+                    properties: {
+                        unit: {
+                            type: string;
+                            description: string;
+                        };
+                        thingPage: {
+                            type: string;
+                            properties: {
+                                statusBar: {
+                                    type: string;
+                                    description: string;
+                                };
+                                graph: {
+                                    type: string;
+                                    description: string;
+                                };
+                                stateIndicator: {
+                                    type: string;
+                                    description: string;
+                                    oneOf: {
+                                        type: string;
+                                        properties: {
+                                            type: {
+                                                type: string;
+                                                enum: string[];
+                                            };
+                                            thresholds: {
+                                                type: string;
+                                                items: {
+                                                    type: string;
+                                                };
+                                                minItems: number;
+                                                maxItems: number;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: boolean;
+                                    }[];
+                                };
+                            };
+                            additionalProperties: boolean;
+                        };
+                        enum: {
+                            type: string;
+                            patternProperties: {
+                                "^-?\\d+$": {
+                                    type: string;
+                                    minProperties: number;
+                                    description: string;
+                                    additionalProperties: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                            additionalProperties: boolean;
+                        };
+                        values: {
+                            type: string;
+                            description: string;
+                            properties: {
+                                temperature: {
+                                    type: string;
+                                    description: string;
+                                };
+                                humidity: {
+                                    type: string;
+                                    description: string;
+                                };
+                                pressure: {
+                                    type: string;
+                                    description: string;
+                                };
+                                resistance: {
+                                    type: string;
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: boolean;
+                        };
+                        translations: {
+                            type: string;
+                            minProperties: number;
+                            description: string;
+                            additionalProperties: {
+                                type: string;
+                            };
+                        };
+                        calculationType: {
+                            type: string;
+                            enum: SupportedDerivedValues[];
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        } | {
+            type: string;
+            properties: {
+                name: {
+                    type: string;
+                    minLength: number;
+                    description: string;
+                };
+                type: {
+                    type: string;
+                    enum: CapabilityType[];
+                };
+                command: {};
+                metadata: {
+                    type: string;
+                    description: string;
+                    properties: {
+                        thingPage: {
+                            type: string;
+                            properties: {
+                                canBeTriggeredBy: {
+                                    type: string;
+                                    items: {
+                                        type: string;
+                                        enum: CapabilityCanBeTriggeredBy[];
+                                    };
+                                };
+                            };
+                            required: string[];
+                        };
+                        translations: {
+                            type: string;
+                            minProperties: number;
+                            description: string;
+                            additionalProperties: {
+                                type: string;
+                            };
+                        };
+                        commandSchema: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        } | {
+            type: string;
+            properties: {
+                name: {
+                    type: string;
+                    minLength: number;
+                    description: string;
+                };
+                type: {
+                    type: string;
+                    enum: CapabilityType[];
+                };
+                metadata: {
+                    type: string;
+                    properties: {
+                        value: {
+                            type: string;
+                        };
+                        interval: {
+                            type: string;
+                            pattern: string;
+                            description: string;
+                        };
+                        thingPage: {
+                            type: string;
+                            properties: {
+                                statusBar: {
+                                    type: string;
+                                    description: string;
+                                };
+                                graph: {
+                                    type: string;
+                                    description: string;
+                                };
+                                stateIndicator: {
+                                    type: string;
+                                    description: string;
+                                    oneOf: {
+                                        type: string;
+                                        properties: {
+                                            type: {
+                                                type: string;
+                                                enum: string[];
+                                            };
+                                            thresholds: {
+                                                type: string;
+                                                items: {
+                                                    type: string;
+                                                };
+                                                minItems: number;
+                                                maxItems: number;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: boolean;
+                                    }[];
+                                };
+                            };
+                            additionalProperties: boolean;
+                        };
+                        enum: {
+                            type: string;
+                            patternProperties: {
+                                "^-?\\d+$": {
+                                    type: string;
+                                    minProperties: number;
+                                    description: string;
+                                    additionalProperties: {
+                                        type: string;
+                                    };
+                                };
+                            };
+                            additionalProperties: boolean;
+                        };
+                        translations: {
+                            type: string;
+                            minProperties: number;
+                            description: string;
+                            additionalProperties: {
+                                type: string;
+                            };
+                        };
+                    };
+                    required: string[];
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        })[];
+    };
+};
+export {};

package/api/schemas/productTypes/updateProductTypeSchema.d.ts

@@ -0,0 +1,60 @@
+import { ThingVersion } from "../../../constants/constants";
+export declare const updateProductTypeSchema: {
+    type: string;
+    properties: {
+        name: {
+            type: string;
+            minLength: number;
+        };
+        description: {
+            type: string;
+        };
+        dashboardUri: {
+            type: string;
+        };
+        productImageUrl: {
+            type: string;
+        };
+        category: {
+            enum: readonly ["sensor", "property", "health", "other", "waterSwitch", "waterMeter", "waterSensor", "weatherSensor"];
+            default: "sensor";
+        };
+        manufacturer: {
+            type: string;
+        };
+        heartbeat: {
+            type: string;
+            properties: {
+                interval: {
+                    type: string[];
+                    default: number;
+                };
+                timeout: {
+                    type: string[];
+                    default: number;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        canOnlyBeAddedByGlobal: {
+            type: string;
+        };
+        serialNumberPrefix: {
+            type: string;
+            maxLength: number;
+        };
+        serialNumberQrRegex: {
+            type: string;
+            maxLength: number;
+        };
+        supportedThingVersions: {
+            type: string;
+            items: {
+                type: string;
+                enum: ThingVersion[];
+            };
+            default: ThingVersion[];
+        };
+    };
+    additionalProperties: boolean;
+};

package/api/schemas/schemasShared.d.ts

@@ -0,0 +1,9 @@
+export declare const idSchema: {
+    type: string;
+    minLength: number;
+};
+export declare const userSchema: {
+    type: string;
+};
+/** https://en.wikipedia.org/wiki/E.164 */
+export declare const e164number = "^\\+?[1-9]\\d{1,14}$";

package/lib/generator/index.d.ts

@@ -0,0 +1,19 @@
+import { Method, Request } from "..";
+import { JsonResponse } from "../models/JsonResponse";
+interface RequestBody {
+    /**
+     * A map of endpoints to include in the generated API client.
+     * The keys are HTTP methods (e.g., "get", "post", etc.),
+     * and the values are arrays of endpoint paths.
+     * For example:
+     * {
+     *   "get": ["/users", "/users/:userId"],
+     *   "post": ["/users", "/users/:userId/follow"],
+     * }
+     */
+    endpointsToInclude: {
+        [key in Method]?: string[];
+    };
+}
+export declare function generateApiClientEndpoint(req: Request<RequestBody>): Promise<JsonResponse<string>>;
+export {};