swoop-common 2.2.128 → 2.2.130

package/README.md

@@ -1,225 +1,225 @@
-.# Swoop Library
-
-This library is used for rendering **Swoop itinerary templates**.
-It provides tools for defining **custom field types**, registering **custom components**,
-rendering templates from a **MasterSchema**, and includes SDKs for all related services.
-It supports both input mode (for creating templates) and presentation mode (for rendering them for end users).
-The schema system is stage-aware, enabling precise control over what data is editable or displayed at which stage.
-
-> Note: This package is intended for internal use only.
-
----
-
-# Swoop Library
-
-## Initialization
-
-Before using the Swoop Library, you must initialize it with service URLs:
-
-```ts
-import { init } from "swoop-common";
-
-init({
-  coreServiceUrl: "https://your.core.service",
-  swoopServiceForwardUrl: "https://your.forward.service",
-});
-```
-
-## Service Interfaces
-
-The library provides three primary service interfaces to interact with backend systems:
-
-- **SwoopService** — Interfaces with the Swoop API.
-- **CoreService** — For core service.
-
-These interfaces offer convenient methods to work seamlessly with the underlying services required by the itinerary system.
-
-## StyledFormView
-
-The `StyledFormView` component is the entry point for rendering a full itinerary template. It handles schema parsing and renderer injection based on mode and form stage.
-
-```tsx
-import { StyledFormView } from "your-form-library";
-
-<StyledFormView
-  initialData={/* object */}
-  schema={/* MasterSchema */}
-  onChange={(val) => console.log(val)}
-  pool="FORM"
-  readonly={false}
-  stage="Inst"
-/>;
-```
-
-### Props
-
-| Name        | Type                 | Description                                                        |
-| ----------- | -------------------- | ------------------------------------------------------------------ |
-| initialData | `any`                | Initial values for the template. Should not be updated frequently. |
-| schema      | `MasterSchema`       | Template definition object.                                        |
-| onChange    | `(val: any) => void` | Callback with updated data.                                        |
-| pool        | `ComponentPool`      | `"FORM"` or `"PRESENTATION"` depending on context.                 |
-| readonly    | `boolean`            | Disables inputs if true (only relevant in FORM pool).              |
-| stage       | `Stage`              | Controls which data segment is being rendered.                     |
-
-### Stages
-
-The template system is divided into stages:
-
-- **Stage.Comp** – Data stored on the root component, often static (e.g. metadata, titles). Does not include any dynamic or time-based fields.
-- **Stage.Inst** – Instance-specific data (e.g. timings, localized notes). This is the most common stage for editable fields.
-- **Stage.User** – Data unique to individual users (e.g. room number).
-
-Each stage builds on the one before it. For example, `Stage.User` includes everything from `Stage.Comp` and `Stage.Inst`. Fields are editable based on the current stage. If a value is defined in two stages, the lower stage will take priority.
-
----
-
-## Custom Components
-
-Custom components define how individual fields render. These can behave like typical form inputs or be used for display-only formatting in the `PRESENTATION` pool.
-
-### Example
-
-```tsx
-const FormExample: React.FC<Props> = ({
-  text,
-  onChange,
-  getError,
-  label,
-  enabled,
-}) => {
-  const [val, setVal] = useState(text);
-  const error = getError ? getError("example")?.message : undefined;
-  const onChangeDebounced = useMemo(() => debounce(onChange, 300), [onChange]);
-
-  const update = (value: string) => {
-    setVal(value);
-    onChangeDebounced(value);
-  };
-
-  return (
-    <Paper
-      sx={{
-        display: "flex",
-        flexDirection: "column",
-        gap: 1,
-        p: 2,
-        background: "#CBC3E3",
-        mb: 1,
-      }}
-    >
-      {!enabled && "THIS IS DISABLED"}
-      <Typography variant="h6">{label}</Typography>
-      <TextField
-        label="Example label"
-        value={val}
-        onChange={(e) => update(e.target.value)}
-        error={!!error}
-        helperText={error}
-        disabled={!enabled}
-      />
-    </Paper>
-  );
-};
-
-const FormRendererExample: React.FC<ControlProps> = ({
-  data,
-  handleChange,
-  path,
-  label,
-  enabled,
-}) => {
-  const getError = useLocalErrors(path);
-  return (
-    <FormExample
-      text={data as string}
-      onChange={(val) => handleChange(path, val)}
-      getError={getError}
-      label={label}
-      enabled={enabled}
-    />
-  );
-};
-
-registerComponent("example", FormRendererExample, ComponentPool.FORM);
-registerComponent("example", FormRendererExample, ComponentPool.PRESENTATION);
-```
-
-> Important: You **cannot register two components with the same name within the same pool**. You _can_ register the same component name across different pools (e.g., `"example"` in both `"FORM"` and `"PRESENTATION"`).
-
-### Presentation Pool
-
-The `PRESENTATION` pool is more than just read-only. It is designed for **customer-facing output**, rendering fields in a clean, non-form-like layout for readability and professionalism.
-
----
-
-## Custom Types
-
-Custom field types define what kinds of fields can be used when **building a template**. These appear in the template builder UI as selectable field types and control how data is validated and configured.
-
-### Syntax
-
-```ts
-registerType(
-  "typeId", // Unique type string
-  "Display Name", // Name shown in template builder
-  schema, // JSON Schema defining the data structure
-  optionsSchema, // JSON Schema defining configuration data structure
-  requiredOptions // boolean: must the options be filled?
-);
-```
-
-### Example
-
-```ts
-registerType(
-  "enum",
-  "Dropdown",
-  { type: "array" },
-  {
-    type: "object",
-    title: "Dropdown Options",
-    properties: {
-      enumValues: {
-        title: "Dropdown Values",
-        type: "array",
-        items: { type: "string" },
-      },
-    },
-  },
-  true
-);
-```
-
-This type defines a dropdown field where the values are defined via the `enumValues` property in the template configuration.
-
-### Custom Option Editors
-
-If you want to render a **custom options block** (i.e., how the field type's options are displayed in the template editor), you must do the following:
-
-1. In the top-level `optionsSchema` of the type, define `"x-type": "yourTypeName"`
-2. Create and register a custom component with the name `"yourTypeName"` in the `"FORM"` pool.
-
-This component will then be used to render the configuration UI for that field type.
-
----
-
-## File Locations
-
-- **Custom components** must be placed in `src/renderers`. They may be nested within subfolders. All files inside `renderers/` will be automatically imported in the correct order.
-- **Custom types** must be added to `src/default_registration/fields_base.tsx`.
-
-No manual import wiring is required beyond placing the file in the correct folder.
-
----
-
-## Publishing to NPM
-
-To publish a new version of the package:
-
-```bash
-npm run build             # Compile the package
-npm version patch         # Bump the patch version (or use minor/major as needed)
-npm adduser               # Log in to NPM (if not already)
-npm publish               # Publish the package
-```
+.# Swoop Library
+
+This library is used for rendering **Swoop itinerary templates**.
+It provides tools for defining **custom field types**, registering **custom components**,
+rendering templates from a **MasterSchema**, and includes SDKs for all related services.
+It supports both input mode (for creating templates) and presentation mode (for rendering them for end users).
+The schema system is stage-aware, enabling precise control over what data is editable or displayed at which stage.
+
+> Note: This package is intended for internal use only.
+
+---
+
+# Swoop Library
+
+## Initialization
+
+Before using the Swoop Library, you must initialize it with service URLs:
+
+```ts
+import { init } from "swoop-common";
+
+init({
+  coreServiceUrl: "https://your.core.service",
+  swoopServiceForwardUrl: "https://your.forward.service",
+});
+```
+
+## Service Interfaces
+
+The library provides three primary service interfaces to interact with backend systems:
+
+- **SwoopService** — Interfaces with the Swoop API.
+- **CoreService** — For core service.
+
+These interfaces offer convenient methods to work seamlessly with the underlying services required by the itinerary system.
+
+## StyledFormView
+
+The `StyledFormView` component is the entry point for rendering a full itinerary template. It handles schema parsing and renderer injection based on mode and form stage.
+
+```tsx
+import { StyledFormView } from "your-form-library";
+
+<StyledFormView
+  initialData={/* object */}
+  schema={/* MasterSchema */}
+  onChange={(val) => console.log(val)}
+  pool="FORM"
+  readonly={false}
+  stage="Inst"
+/>;
+```
+
+### Props
+
+| Name        | Type                 | Description                                                        |
+| ----------- | -------------------- | ------------------------------------------------------------------ |
+| initialData | `any`                | Initial values for the template. Should not be updated frequently. |
+| schema      | `MasterSchema`       | Template definition object.                                        |
+| onChange    | `(val: any) => void` | Callback with updated data.                                        |
+| pool        | `ComponentPool`      | `"FORM"` or `"PRESENTATION"` depending on context.                 |
+| readonly    | `boolean`            | Disables inputs if true (only relevant in FORM pool).              |
+| stage       | `Stage`              | Controls which data segment is being rendered.                     |
+
+### Stages
+
+The template system is divided into stages:
+
+- **Stage.Comp** – Data stored on the root component, often static (e.g. metadata, titles). Does not include any dynamic or time-based fields.
+- **Stage.Inst** – Instance-specific data (e.g. timings, localized notes). This is the most common stage for editable fields.
+- **Stage.User** – Data unique to individual users (e.g. room number).
+
+Each stage builds on the one before it. For example, `Stage.User` includes everything from `Stage.Comp` and `Stage.Inst`. Fields are editable based on the current stage. If a value is defined in two stages, the lower stage will take priority.
+
+---
+
+## Custom Components
+
+Custom components define how individual fields render. These can behave like typical form inputs or be used for display-only formatting in the `PRESENTATION` pool.
+
+### Example
+
+```tsx
+const FormExample: React.FC<Props> = ({
+  text,
+  onChange,
+  getError,
+  label,
+  enabled,
+}) => {
+  const [val, setVal] = useState(text);
+  const error = getError ? getError("example")?.message : undefined;
+  const onChangeDebounced = useMemo(() => debounce(onChange, 300), [onChange]);
+
+  const update = (value: string) => {
+    setVal(value);
+    onChangeDebounced(value);
+  };
+
+  return (
+    <Paper
+      sx={{
+        display: "flex",
+        flexDirection: "column",
+        gap: 1,
+        p: 2,
+        background: "#CBC3E3",
+        mb: 1,
+      }}
+    >
+      {!enabled && "THIS IS DISABLED"}
+      <Typography variant="h6">{label}</Typography>
+      <TextField
+        label="Example label"
+        value={val}
+        onChange={(e) => update(e.target.value)}
+        error={!!error}
+        helperText={error}
+        disabled={!enabled}
+      />
+    </Paper>
+  );
+};
+
+const FormRendererExample: React.FC<ControlProps> = ({
+  data,
+  handleChange,
+  path,
+  label,
+  enabled,
+}) => {
+  const getError = useLocalErrors(path);
+  return (
+    <FormExample
+      text={data as string}
+      onChange={(val) => handleChange(path, val)}
+      getError={getError}
+      label={label}
+      enabled={enabled}
+    />
+  );
+};
+
+registerComponent("example", FormRendererExample, ComponentPool.FORM);
+registerComponent("example", FormRendererExample, ComponentPool.PRESENTATION);
+```
+
+> Important: You **cannot register two components with the same name within the same pool**. You _can_ register the same component name across different pools (e.g., `"example"` in both `"FORM"` and `"PRESENTATION"`).
+
+### Presentation Pool
+
+The `PRESENTATION` pool is more than just read-only. It is designed for **customer-facing output**, rendering fields in a clean, non-form-like layout for readability and professionalism.
+
+---
+
+## Custom Types
+
+Custom field types define what kinds of fields can be used when **building a template**. These appear in the template builder UI as selectable field types and control how data is validated and configured.
+
+### Syntax
+
+```ts
+registerType(
+  "typeId", // Unique type string
+  "Display Name", // Name shown in template builder
+  schema, // JSON Schema defining the data structure
+  optionsSchema, // JSON Schema defining configuration data structure
+  requiredOptions // boolean: must the options be filled?
+);
+```
+
+### Example
+
+```ts
+registerType(
+  "enum",
+  "Dropdown",
+  { type: "array" },
+  {
+    type: "object",
+    title: "Dropdown Options",
+    properties: {
+      enumValues: {
+        title: "Dropdown Values",
+        type: "array",
+        items: { type: "string" },
+      },
+    },
+  },
+  true
+);
+```
+
+This type defines a dropdown field where the values are defined via the `enumValues` property in the template configuration.
+
+### Custom Option Editors
+
+If you want to render a **custom options block** (i.e., how the field type's options are displayed in the template editor), you must do the following:
+
+1. In the top-level `optionsSchema` of the type, define `"x-type": "yourTypeName"`
+2. Create and register a custom component with the name `"yourTypeName"` in the `"FORM"` pool.
+
+This component will then be used to render the configuration UI for that field type.
+
+---
+
+## File Locations
+
+- **Custom components** must be placed in `src/renderers`. They may be nested within subfolders. All files inside `renderers/` will be automatically imported in the correct order.
+- **Custom types** must be added to `src/default_registration/fields_base.tsx`.
+
+No manual import wiring is required beyond placing the file in the correct folder.
+
+---
+
+## Publishing to NPM
+
+To publish a new version of the package:
+
+```bash
+npm run build             # Compile the package
+npm version patch         # Bump the patch version (or use minor/major as needed)
+npm adduser               # Log in to NPM (if not already)
+npm publish               # Publish the package
+```

package/dist/api/generated/swoop/services/SwoopService.d.ts

@@ -278,10 +278,12 @@ export declare class SwoopService {
      * @param region antarctica, arctic, patagonia
      * @param search Search against title, alias, description, name, telephone, email
      * @param active Filter by active status (0,1)
+     * @param startDate Filter partners with departures from this date (YYYY-MM-DD)
+     * @param endDate Filter partners with departures until this date (YYYY-MM-DD)
      * @returns Partner Partner collection
      * @throws ApiError
      */
-    partnersGetCollection(page?: number, itemsPerPage?: number, region?: string, search?: string, active?: string): CancelablePromise<Array<Partner>>;
+    partnersGetCollection(page?: number, itemsPerPage?: number, region?: string, search?: string, active?: string, startDate?: string, endDate?: string): CancelablePromise<Array<Partner>>;
     /**
      * Retrieves a Partner resource.
      * Retrieves a Partner resource.
@@ -348,10 +350,12 @@ export declare class SwoopService {
      * @param search Search against title
      * @param region antarctica, arctic, patagonia
      * @param publishstate unpublished, approval, published, rejected
+     * @param startDate Filter trips with departures from this date (YYYY-MM-DD)
+     * @param endDate Filter trips with departures until this date (YYYY-MM-DD)
      * @returns Trip Trip collection
      * @throws ApiError
      */
-    tripsGetCollection(page?: number, itemsPerPage?: number, search?: string, region?: string, publishstate?: string): CancelablePromise<Array<Trip>>;
+    tripsGetCollection(page?: number, itemsPerPage?: number, search?: string, region?: string, publishstate?: string, startDate?: string, endDate?: string): CancelablePromise<Array<Trip>>;
     /**
      * Retrieves a Trip resource.
      * Retrieves a Trip resource.

package/dist/api/generated/swoop/services/SwoopService.js

@@ -430,10 +430,12 @@ export class SwoopService {
      * @param region antarctica, arctic, patagonia
      * @param search Search against title, alias, description, name, telephone, email
      * @param active Filter by active status (0,1)
+     * @param startDate Filter partners with departures from this date (YYYY-MM-DD)
+     * @param endDate Filter partners with departures until this date (YYYY-MM-DD)
      * @returns Partner Partner collection
      * @throws ApiError
      */
-    partnersGetCollection(page = 1, itemsPerPage = 30, region, search, active) {
+    partnersGetCollection(page = 1, itemsPerPage = 30, region, search, active, startDate, endDate) {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/partners',
@@ -443,6 +445,8 @@ export class SwoopService {
                 'region': region,
                 'search': search,
                 'active': active,
+                'startDate': startDate,
+                'endDate': endDate,
             },
         });
     }
@@ -567,10 +571,12 @@ export class SwoopService {
      * @param search Search against title
      * @param region antarctica, arctic, patagonia
      * @param publishstate unpublished, approval, published, rejected
+     * @param startDate Filter trips with departures from this date (YYYY-MM-DD)
+     * @param endDate Filter trips with departures until this date (YYYY-MM-DD)
      * @returns Trip Trip collection
      * @throws ApiError
      */
-    tripsGetCollection(page = 1, itemsPerPage = 30, search, region, publishstate) {
+    tripsGetCollection(page = 1, itemsPerPage = 30, search, region, publishstate, startDate, endDate) {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/trips',
@@ -580,6 +586,8 @@ export class SwoopService {
                 'search': search,
                 'region': region,
                 'publishstate': publishstate,
+                'startDate': startDate,
+                'endDate': endDate,
             },
         });
     }

package/package.json

@@ -1,70 +1,70 @@
-{
-    "name": "swoop-common",
-    "version": "2.2.128",
-    "main": "dist/api/index.js",
-    "types": "dist/api/index.d.ts",
-    "exports": {
-        ".": {
-            "import": "./dist/api/index.js",
-            "require": "./dist/api/index.js",
-            "types": "./dist/api/index.d.ts"
-        },
-        "./rendering": {
-            "import": "./dist/rendering/index.js",
-            "require": "./dist/rendering/index.js",
-            "types": "./dist/rendering/index.d.ts"
-        }
-    },
-    "./rendering": {
-        "import": "./dist/rendering/index.js",
-        "require": "./dist/rendering/index.js",
-        "types": "./dist/rendering/index.d.ts"
-    },
-    "files": [
-        "dist"
-    ],
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1",
-        "build": "rimraf ./dist && tsc",
-        "build-imports": "tsx ./src/rendering/prebuild/import.ts",
-        "generate-swoop-specs": "tsx ./src/api/specsgen.ts",
-        "build-core-sdk": "npx openapi-typescript-codegen --input ./openapi/core_service.yaml --output ./src/api/generated/core --client fetch",
-        "build-swoop-sdk": "npm run generate-swoop-specs && npx openapi-typescript-codegen --input ./openapi/swoop_service.yaml --output ./src/api/generated/swoop --client fetch --postfixModels Swoop --request ./src/api/templates/request.ts",
-        "prebuild": "npm run build-imports && npm run build-sdk",
-        "build-sdk-exports": "tsx ./src/api/gen.ts",
-        "build-sdk": "npm run build-core-sdk && npm run build-swoop-sdk && npm run build-sdk-exports"
-    },
-    "author": "",
-    "license": "ISC",
-    "description": "",
-    "dependencies": {
-        "@apidevtools/swagger-parser": "^12.0.0",
-        "@emotion/react": "^11.14.0",
-        "@emotion/styled": "^11.14.1",
-        "@jsonforms/core": "^3.7.0",
-        "@jsonforms/material-renderers": "^3.7.0",
-        "@jsonforms/react": "^3.7.0",
-        "@mui/icons-material": "^7.3.8",
-        "@mui/material": "^7.3.8",
-        "@mui/system": "^7.3.8",
-        "ajv": "^8.17.1",
-        "js-yaml": "^4.1.1",
-        "lodash.merge": "^4.6.2",
-        "openapi-ts": "^0.3.4",
-        "react": "^19.0.0",
-        "react-simple-wysiwyg": "^3.4.1",
-        "rimraf": "^6.0.1"
-    },
-    "devDependencies": {
-        "@apidevtools/swagger-cli": "^4.0.4",
-        "@hey-api/openapi-ts": "^0.80.2",
-        "@types/js-yaml": "^4.0.9",
-        "@types/lodash.merge": "^4.6.9",
-        "@types/node": "^24.0.14",
-        "@types/react": "^19",
-        "dotenv": "^17.3.1",
-        "openapi-typescript-codegen": "^0.29.0",
-        "tsx": "^4.20.3",
-        "typescript": "^5.8.3"
-    }
-}
+{
+    "name": "swoop-common",
+    "version": "2.2.130",
+    "main": "dist/api/index.js",
+    "types": "dist/api/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/api/index.js",
+            "require": "./dist/api/index.js",
+            "types": "./dist/api/index.d.ts"
+        },
+        "./rendering": {
+            "import": "./dist/rendering/index.js",
+            "require": "./dist/rendering/index.js",
+            "types": "./dist/rendering/index.d.ts"
+        }
+    },
+    "./rendering": {
+        "import": "./dist/rendering/index.js",
+        "require": "./dist/rendering/index.js",
+        "types": "./dist/rendering/index.d.ts"
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "build": "rimraf ./dist && tsc",
+        "build-imports": "tsx ./src/rendering/prebuild/import.ts",
+        "generate-swoop-specs": "tsx ./src/api/specsgen.ts",
+        "build-core-sdk": "npx openapi-typescript-codegen --input ./openapi/core_service.yaml --output ./src/api/generated/core --client fetch",
+        "build-swoop-sdk": "npm run generate-swoop-specs && npx openapi-typescript-codegen --input ./openapi/swoop_service.yaml --output ./src/api/generated/swoop --client fetch --postfixModels Swoop --request ./src/api/templates/request.ts",
+        "prebuild": "npm run build-imports && npm run build-sdk",
+        "build-sdk-exports": "tsx ./src/api/gen.ts",
+        "build-sdk": "npm run build-core-sdk && npm run build-swoop-sdk && npm run build-sdk-exports"
+    },
+    "author": "",
+    "license": "ISC",
+    "description": "",
+    "dependencies": {
+        "@apidevtools/swagger-parser": "^12.0.0",
+        "@emotion/react": "^11.14.0",
+        "@emotion/styled": "^11.14.1",
+        "@jsonforms/core": "^3.7.0",
+        "@jsonforms/material-renderers": "^3.7.0",
+        "@jsonforms/react": "^3.7.0",
+        "@mui/icons-material": "^7.3.8",
+        "@mui/material": "^7.3.8",
+        "@mui/system": "^7.3.8",
+        "ajv": "^8.17.1",
+        "js-yaml": "^4.1.1",
+        "lodash.merge": "^4.6.2",
+        "openapi-ts": "^0.3.4",
+        "react": "^19.0.0",
+        "react-simple-wysiwyg": "^3.4.1",
+        "rimraf": "^6.0.1"
+    },
+    "devDependencies": {
+        "@apidevtools/swagger-cli": "^4.0.4",
+        "@hey-api/openapi-ts": "^0.80.2",
+        "@types/js-yaml": "^4.0.9",
+        "@types/lodash.merge": "^4.6.9",
+        "@types/node": "^24.0.14",
+        "@types/react": "^19",
+        "dotenv": "^17.3.1",
+        "openapi-typescript-codegen": "^0.29.0",
+        "tsx": "^4.20.3",
+        "typescript": "^5.8.3"
+    }
+}