@happyvertical/smrt-places 0.57.36 → 0.57.38

package/dist/manifest.json

@@ -2,7 +2,7 @@
   "version": "1.0.0",
   "timestamp": 0,
   "packageName": "@happyvertical/smrt-places",
-  "packageVersion": "0.57.36",
+  "packageVersion": "0.57.38",
   "objects": {
     "@happyvertical/smrt-places:PlaceAssetCollection": {
       "name": "placeassetcollection",
@@ -949,65 +949,123 @@
         "typeId": {
           "type": "foreignKey",
           "required": false,
-          "related": "PlaceType"
+          "related": "PlaceType",
+          "description": "What kind of place this is, such as a building, a room or a storage zone.",
+          "_meta": {
+            "description": "What kind of place this is, such as a building, a room or a storage zone."
+          }
         },
         "name": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "What the place is called, such as \"Main warehouse\" or \"Aisle 4\".",
+          "_meta": {
+            "description": "What the place is called, such as \"Main warehouse\" or \"Aisle 4\"."
+          }
         },
         "description": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "A few words about the place and what happens there.",
+          "_meta": {
+            "description": "A few words about the place and what happens there."
+          }
         },
         "latitude": {
           "type": "decimal",
           "required": false,
-          "_meta": {}
+          "description": "How far north or south the place is on a map. Leave empty for a place that is not on a map.",
+          "_meta": {
+            "description": "How far north or south the place is on a map. Leave empty for a place that is not on a map."
+          }
         },
         "longitude": {
           "type": "decimal",
           "required": false,
-          "_meta": {}
+          "description": "How far east or west the place is on a map. Leave empty for a place that is not on a map.",
+          "_meta": {
+            "description": "How far east or west the place is on a map. Leave empty for a place that is not on a map."
+          }
         },
         "streetNumber": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The number of the building on its street.",
+          "_meta": {
+            "description": "The number of the building on its street."
+          }
         },
         "streetName": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The name of the street the place is on.",
+          "_meta": {
+            "description": "The name of the street the place is on."
+          }
         },
         "city": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The town or city the place is in.",
+          "_meta": {
+            "description": "The town or city the place is in."
+          }
         },
         "region": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The state, province or region the place is in.",
+          "_meta": {
+            "description": "The state, province or region the place is in."
+          }
         },
         "country": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The country the place is in.",
+          "_meta": {
+            "description": "The country the place is in."
+          }
         },
         "postalCode": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The postal or zip code of the address.",
+          "_meta": {
+            "description": "The postal or zip code of the address."
+          }
         },
         "countryCode": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The short two-letter code for the country, such as CA or US.",
+          "_meta": {
+            "description": "The short two-letter code for the country, such as CA or US."
+          }
         },
         "timezone": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The time zone the place keeps, such as America/Toronto.",
+          "_meta": {
+            "description": "The time zone the place keeps, such as America/Toronto."
+          }
         },
         "externalId": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The reference the map provider uses for this place, filled in when the app looks it up.",
+          "_meta": {
+            "description": "The reference the map provider uses for this place, filled in when the app looks it up."
+          }
         },
         "source": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "Which map provider the place was looked up from, if any.",
+          "_meta": {
+            "description": "Which map provider the place was looked up from, if any."
+          }
         },
         "metadata": {
           "type": "text",
@@ -1656,13 +1714,19 @@
           "type": "text",
           "required": true,
           "default": "",
+          "description": "The name of the kind of place, such as \"Building\", \"Room\" or \"Zone\".",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "The name of the kind of place, such as \"Building\", \"Room\" or \"Zone\"."
           }
         },
         "description": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "A few words about when to use this kind of place.",
+          "_meta": {
+            "description": "A few words about when to use this kind of place."
+          }
         },
         "createdAt": {
           "type": "text",
@@ -1798,6 +1862,165 @@
     }
   },
   "moduleType": "smrt",
+  "recipes": [
+    {
+      "id": "places.locations",
+      "className": "PlacesLocationsRecipe",
+      "label": "Places",
+      "summary": "Keep a list of the places your work happens, such as sites, buildings, rooms and storage zones, one inside another.",
+      "synonyms": [
+        "places",
+        "locations",
+        "sites",
+        "buildings",
+        "rooms",
+        "addresses",
+        "warehouses"
+      ],
+      "models": [
+        "@happyvertical/smrt-places:Place",
+        "@happyvertical/smrt-places:PlaceType"
+      ],
+      "nav": [
+        {
+          "label": "Places",
+          "model": "@happyvertical/smrt-places:Place",
+          "icon": "home",
+          "description": "Every site, building, room and zone, with its address and what it is inside.",
+          "noun": "place"
+        },
+        {
+          "label": "Place types",
+          "model": "@happyvertical/smrt-places:PlaceType",
+          "icon": "tag",
+          "description": "The kinds of place you keep, such as building or room.",
+          "noun": "place type"
+        }
+      ],
+      "requires": [],
+      "section": {
+        "id": "places",
+        "label": "Locations",
+        "icon": "home",
+        "description": "The places your work happens."
+      },
+      "options": {
+        "@happyvertical/smrt-places:Place": {
+          "fields": {
+            "name": {
+              "order": 1
+            },
+            "typeId": {
+              "label": "Type",
+              "order": 2
+            },
+            "parentId": {
+              "label": "Inside",
+              "help": "The larger place this one is part of, such as the building a room is in.",
+              "order": 3
+            },
+            "description": {
+              "order": 4
+            },
+            "streetNumber": {
+              "label": "Street number",
+              "order": 5
+            },
+            "streetName": {
+              "label": "Street name",
+              "order": 6
+            },
+            "city": {
+              "order": 7
+            },
+            "region": {
+              "order": 8
+            },
+            "country": {
+              "order": 9
+            },
+            "postalCode": {
+              "label": "Postal code",
+              "order": 10
+            },
+            "latitude": {
+              "visibility": "advanced"
+            },
+            "longitude": {
+              "visibility": "advanced"
+            },
+            "countryCode": {
+              "label": "Country code",
+              "visibility": "advanced"
+            },
+            "timezone": {
+              "label": "Time zone",
+              "visibility": "advanced"
+            },
+            "externalId": {
+              "label": "Map reference",
+              "visibility": "advanced"
+            },
+            "source": {
+              "label": "Map provider",
+              "visibility": "advanced"
+            },
+            "metadata": {
+              "visibility": "hidden"
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            },
+            "createdAt": {
+              "visibility": "hidden"
+            },
+            "updatedAt": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-places:PlaceType": {
+          "fields": {
+            "name": {
+              "order": 1
+            },
+            "description": {
+              "order": 2
+            },
+            "createdAt": {
+              "visibility": "hidden"
+            },
+            "updatedAt": {
+              "visibility": "hidden"
+            }
+          }
+        }
+      },
+      "help": {
+        "markdown": "## Overview\n\nPlaces is where you keep the sites, buildings, rooms and storage zones your\nwork happens in. Each place has a name, a type and, when it is somewhere real,\nan address. A place can sit inside a larger one, so a room belongs to a\nbuilding and a shelf to a room, and you can follow that chain either way. A\nplace does not have to be on a map: a storage zone or a work area with no\naddress is fine.\n\n## Tasks\n\n### Add a place\n\n1. Open the list of places and choose **New**.\n2. Type the **{field:Place.name}**, for example \"Main warehouse\".\n3. Pick its **{field:Place.typeId}**, such as building or room. Add a type first if the one you need is missing.\n4. Fill in the address: the **{field:Place.streetNumber}**, **{field:Place.streetName}**, **{field:Place.city}**, **{field:Place.region}**, **{field:Place.country}** and **{field:Place.postalCode}**. Leave these empty for a place that is not on a map.\n5. Save. When your app searches a map for a place, it can add the place for you with the address filled in from the map provider.\n\n### Put a place inside another\n\n1. Open the place and choose to edit it.\n2. In **{field:Place.parentId}**, pick the larger place it belongs to, such as the building a room is in.\n3. Save. The place now shows up under the one you chose.\n\n### Change or remove a place\n\n1. Open the place and choose to edit it.\n2. Change the **{field:Place.name}**, **{field:Place.description}** or address, then save.\n3. To remove a place you no longer use, open it and choose to delete it. Move anything inside it first.\n\n### Add a place type\n\n1. Open the list of place types and choose **New**.\n2. Type the **{field:PlaceType.name}**, for example \"Room\".\n3. Add a **{field:PlaceType.description}** so others know when to use it.\n4. Save. The type can now be picked when you add a place.\n",
+        "fieldRefs": [
+          "Place.city",
+          "Place.country",
+          "Place.description",
+          "Place.name",
+          "Place.parentId",
+          "Place.postalCode",
+          "Place.region",
+          "Place.streetName",
+          "Place.streetNumber",
+          "Place.typeId",
+          "PlaceType.description",
+          "PlaceType.name"
+        ]
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package does not build for a browser: geo -> cache -> redis, node:zlib; url-signature node:crypto; and its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3624, #3627)."
+        ]
+      }
+    }
+  ],
   "smrtDependencies": [
     "@happyvertical/smrt-assets",
     "@happyvertical/smrt-core",

package/dist/models/Place.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Place.d.ts","sourceRoot":"","sources":["../../src/models/Place.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAOxD,OAAO,EAGL,gBAAgB,EAEjB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAU,CAAC;AAEtD,6DAA6D;AAC7D,eAAO,MAAM,6BAA6B,SAAS,CAAC;AAEpD,qBAOa,KAAM,SAAQ,gBAAgB;IAKzC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAI/B,MAAM,SAAM;IAEZ,IAAI,SAAM;IACV,WAAW,SAAM;IAIjB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAChC,YAAY,SAAM;IAClB,UAAU,SAAM;IAChB,IAAI,SAAM;IACV,MAAM,SAAM;IACZ,OAAO,SAAM;IACb,UAAU,SAAM;IAChB,WAAW,SAAM;IACjB,QAAQ,SAAM;IAGd,UAAU,SAAM;IAChB,MAAM,SAAM;IACZ,QAAQ,SAAM;IAGd,SAAS,OAAc;IACvB,SAAS,OAAc;gBAEX,OAAO,GAAE,YAAiB;IA8CtC;;;;OAIG;IACH,UAAU,IAAI,OAAO;IAerB;;;;OAIG;IACH,cAAc,IAAI,OAAO;IAIzB;;;;OAIG;IACH,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAStC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAIhD;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAKtD;;;;OAIG;IACG,OAAO;YAcC,uBAAuB;IAM/B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAkBlD,QAAQ,CACZ,KAAK,EAAE,KAAK,EACZ,YAAY,SAAe,EAC3B,SAAS,SAAI,GACZ,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAK3C;;;;OAIG;IACG,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBhD,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAYzE"}
+{"version":3,"file":"Place.d.ts","sourceRoot":"","sources":["../../src/models/Place.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAOxD,OAAO,EAGL,gBAAgB,EAEjB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAU,CAAC;AAEtD,6DAA6D;AAC7D,eAAO,MAAM,6BAA6B,SAAS,CAAC;AAEpD,qBAOa,KAAM,SAAQ,gBAAgB;IAKzC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAQ/B,MAAM,SAAM;IAMZ,IAAI,SAAM;IAEV,WAAW,SAAM;IAQjB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAM/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEhC,YAAY,SAAM;IAElB,UAAU,SAAM;IAEhB,IAAI,SAAM;IAEV,MAAM,SAAM;IAEZ,OAAO,SAAM;IAEb,UAAU,SAAM;IAIhB,WAAW,SAAM;IAIjB,QAAQ,SAAM;IAOd,UAAU,SAAM;IAIhB,MAAM,SAAM;IACZ,QAAQ,SAAM;IAGd,SAAS,OAAc;IACvB,SAAS,OAAc;gBAEX,OAAO,GAAE,YAAiB;IA8CtC;;;;OAIG;IACH,UAAU,IAAI,OAAO;IAerB;;;;OAIG;IACH,cAAc,IAAI,OAAO;IAIzB;;;;OAIG;IACH,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAStC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAIhD;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAKtD;;;;OAIG;IACG,OAAO;YAcC,uBAAuB;IAM/B,SAAS,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAkBlD,QAAQ,CACZ,KAAK,EAAE,KAAK,EACZ,YAAY,SAAe,EAC3B,SAAS,SAAI,GACZ,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAK3C;;;;OAIG;IACG,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBhD,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAYzE"}

package/dist/models/PlaceType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PlaceType.d.ts","sourceRoot":"","sources":["../../src/models/PlaceType.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAS,UAAU,EAAQ,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAU,CAAC;AAEjD,qBAMa,SAAU,SAAQ,UAAU;IAGvC,IAAI,EAAE,MAAM,CAAM;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB,SAAS,OAAc;IACvB,SAAS,OAAc;gBAEX,OAAO,GAAE,gBAAqB;IAS1C;;;;;OAKG;WACU,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;CAIjE"}
+{"version":3,"file":"PlaceType.d.ts","sourceRoot":"","sources":["../../src/models/PlaceType.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAS,UAAU,EAAQ,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAU,CAAC;AAEjD,qBAMa,SAAU,SAAQ,UAAU;IAOvC,IAAI,EAAE,MAAM,CAAM;IAGlB,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB,SAAS,OAAc;IACvB,SAAS,OAAc;gBAEX,OAAO,GAAE,gBAAqB;IAS1C;;;;;OAKG;WACU,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;CAIjE"}

package/dist/recipes.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Declared recipes for smrt-places (#4409): user-facing units of
+ * functionality an app or agent can pick instead of the whole package.
+ * The scanner reads these statics into the `recipes` array of `manifest.json`
+ * and `smrt-knowledge.json`; nothing here runs at that point.
+ *
+ * @packageDocumentation
+ */
+import { SmrtRecipe } from '@happyvertical/smrt-core';
+import { Place } from "./models/Place.js";
+import { PlaceType } from "./models/PlaceType.js";
+/**
+ * Places: the buildings, rooms, zones and sites where work happens, one
+ * inside another. `PlaceAsset` (the picture join) is closed to every surface
+ * and stays out of the recipe.
+ */
+export declare class PlacesLocationsRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof PlaceType | typeof Place)[];
+    static nav: ({
+        label: string;
+        model: typeof Place;
+        icon: string;
+        description: string;
+        noun: string;
+    } | {
+        label: string;
+        model: typeof PlaceType;
+        icon: string;
+        description: string;
+        noun: string;
+    })[];
+    static options: {
+        readonly Place: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly typeId: {
+                    readonly label: "Type";
+                    readonly order: 2;
+                };
+                readonly parentId: {
+                    readonly label: "Inside";
+                    readonly help: "The larger place this one is part of, such as the building a room is in.";
+                    readonly order: 3;
+                };
+                readonly description: {
+                    readonly order: 4;
+                };
+                readonly streetNumber: {
+                    readonly label: "Street number";
+                    readonly order: 5;
+                };
+                readonly streetName: {
+                    readonly label: "Street name";
+                    readonly order: 6;
+                };
+                readonly city: {
+                    readonly order: 7;
+                };
+                readonly region: {
+                    readonly order: 8;
+                };
+                readonly country: {
+                    readonly order: 9;
+                };
+                readonly postalCode: {
+                    readonly label: "Postal code";
+                    readonly order: 10;
+                };
+                readonly latitude: {
+                    readonly visibility: "advanced";
+                };
+                readonly longitude: {
+                    readonly visibility: "advanced";
+                };
+                readonly countryCode: {
+                    readonly label: "Country code";
+                    readonly visibility: "advanced";
+                };
+                readonly timezone: {
+                    readonly label: "Time zone";
+                    readonly visibility: "advanced";
+                };
+                readonly externalId: {
+                    readonly label: "Map reference";
+                    readonly visibility: "advanced";
+                };
+                readonly source: {
+                    readonly label: "Map provider";
+                    readonly visibility: "advanced";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly createdAt: {
+                    readonly visibility: "hidden";
+                };
+                readonly updatedAt: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly PlaceType: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly description: {
+                    readonly order: 2;
+                };
+                readonly createdAt: {
+                    readonly visibility: "hidden";
+                };
+                readonly updatedAt: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+    };
+}
+//# sourceMappingURL=recipes.d.ts.map

package/dist/recipes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAgB,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAoB,CAAC;AAE/C;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,UAAU;IACnD,MAAM,CAAC,EAAE,SAAsB;IAC/B,MAAM,CAAC,IAAI,SAA2B;IACtC,MAAM,CAAC,KAAK,SAAY;IACxB,MAAM,CAAC,OAAO,SAC0G;IACxH,MAAM,CAAC,QAAQ,WAQb;IACF,MAAM,CAAC,OAAO;;;;;MAKZ;IACF,MAAM,CAAC,MAAM,sCAAsB;IACnC,MAAM,CAAC,GAAG;;;;;;;;;;;;SAgBR;IACF,MAAM,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAqCH;CACZ"}