@aglyn/plugins-bookings 1.25.0 → 1.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aglyn/plugins-bookings",
3
- "version": "1.25.0",
3
+ "version": "1.26.0",
4
4
  "license": "Apache-2.0",
5
5
  "homepage": "https://aglyn.com",
6
6
  "repository": {
@@ -25,16 +25,16 @@
25
25
  "./package.json": "./package.json"
26
26
  },
27
27
  "dependencies": {
28
- "@aglyn/aglyn": "1.25.0",
29
- "@aglyn/shared-data-mdi": "1.25.0",
30
- "@aglyn/shared-ui-jsx": "1.25.0",
31
- "@aglyn/shared-ui-snackstack": "1.25.0",
32
- "@aglyn/shared-util-email": "1.25.0",
33
- "@aglyn/shared-util-http": "1.25.0",
34
- "@aglyn/shared-util-timestamp": "1.25.0",
35
- "@aglyn/tenant-data-admin": "1.25.0",
36
- "@aglyn/tenant-feature-instance": "1.25.0",
37
- "@aglyn/tenant-runtime": "1.25.0",
28
+ "@aglyn/aglyn": "1.26.0",
29
+ "@aglyn/shared-data-mdi": "1.26.0",
30
+ "@aglyn/shared-ui-jsx": "1.26.0",
31
+ "@aglyn/shared-ui-snackstack": "1.26.0",
32
+ "@aglyn/shared-util-email": "1.26.0",
33
+ "@aglyn/shared-util-http": "1.26.0",
34
+ "@aglyn/shared-util-timestamp": "1.26.0",
35
+ "@aglyn/tenant-data-admin": "1.26.0",
36
+ "@aglyn/tenant-feature-instance": "1.26.0",
37
+ "@aglyn/tenant-runtime": "1.26.0",
38
38
  "@swc/helpers": "0.5.24"
39
39
  },
40
40
  "peerDependencies": {
@@ -19,6 +19,7 @@
19
19
  * (AGL-3643), in the shape `apps/docs/api/resources/bookings.md` documents.
20
20
  */ export const BOOKINGS_API_V1_DESCRIPTION = {
21
21
  tag: 'Bookings',
22
+ docsPage: 'bookings',
22
23
  description: 'A site’s bookings. Read-only over the API.',
23
24
  schemaName: 'Booking',
24
25
  required: [
@@ -70,7 +71,8 @@
70
71
  path: '/v1/sites/{siteId}/bookings',
71
72
  method: 'get',
72
73
  operationId: 'listBookings',
73
- summary: 'List bookings',
74
+ summary: 'List a site’s bookings',
75
+ description: 'Lists the appointments booked on one site, with service, time, customer and status. Needs `siteId` from List sites. Filter by status or service. Read only.',
74
76
  list: true,
75
77
  returns: 'Booking',
76
78
  filters: [
@@ -85,7 +87,8 @@
85
87
  path: '/v1/sites/{siteId}/bookings/{bookingId}',
86
88
  method: 'get',
87
89
  operationId: 'getBooking',
88
- summary: 'Retrieve a booking',
90
+ summary: 'Get a booking',
91
+ description: 'Returns one booking. Needs `siteId` from List sites and `bookingId` from List a site’s bookings.',
89
92
  returns: 'Booking',
90
93
  pathParams: [
91
94
  SITE_ID_PATH_PARAM,
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../../../../../libs/plugins/bookings/src/lib/server/api-v1/openapi.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n type ApiV1ResourceDescription,\n booleanField as bool,\n integerField as int,\n isoField as iso,\n nullableField as nullable,\n objectKindField as OBJECT_FIELD,\n queryParam as q,\n stringField as str,\n SITE_ID_PATH_PARAM,\n} from '@aglyn/tenant-data-admin/server/api-v1-description'\n\n/**\n * A site's bookings as the customer API's OpenAPI document describes them\n * (AGL-3643), in the shape `apps/docs/api/resources/bookings.md` documents.\n */\nexport const BOOKINGS_API_V1_DESCRIPTION: ApiV1ResourceDescription = {\n tag: 'Bookings',\n description: 'A site’s bookings. Read-only over the API.',\n schemaName: 'Booking',\n required: ['id', 'object', 'status'],\n fields: {\n id: str('Booking id.'),\n object: OBJECT_FIELD('booking'),\n serviceId: nullable(str('The booked service.')),\n serviceName: nullable(str('The service’s name when it was booked.')),\n status: {\n type: 'string',\n enum: ['confirmed', 'pendingPayment', 'expired', 'canceled'],\n description:\n '`pendingPayment` is a paid booking whose checkout is still open; `expired` is one whose checkout ran out, and its slot was released.',\n },\n name: nullable(str('The guest’s name.')),\n email: nullable(str('The guest’s email address.')),\n phone: nullable(str('The guest’s phone number, when the service asked for one.')),\n address: {\n type: ['object', 'string', 'null'],\n description: 'The address the service is at, when the service asked for one: the guest’s address parts, or the line they typed.',\n additionalProperties: true,\n },\n startsAt: nullable(iso('When the booking starts, UTC.')),\n endsAt: nullable(iso('When the booking ends, UTC.')),\n timeZone: nullable(str('The IANA time zone the booking was made in.')),\n currency: str('Always `usd`.'),\n paidCents: int('What the guest paid, tax included; 0 for a free booking.'),\n taxCents: int('The tax inside `paidCents`.'),\n refundedCents: int('Refunded so far.'),\n checkedIn: bool('Whether the guest was checked in.'),\n checkedInAt: nullable(iso('When the guest was checked in.')),\n rescheduledFrom: nullable(iso('Where a moved booking started before its latest move.')),\n created: nullable(iso('When the booking was made.')),\n },\n ops: [\n {\n path: '/v1/sites/{siteId}/bookings',\n method: 'get',\n operationId: 'listBookings',\n summary: 'List bookings',\n list: true,\n returns: 'Booking',\n filters: [\n q('status', '`confirmed`, `pendingPayment` or `canceled`. An expired checkout is stored as `pendingPayment`.'),\n q('serviceId', 'Bookings of one service.'),\n ],\n pathParams: [SITE_ID_PATH_PARAM],\n },\n {\n path: '/v1/sites/{siteId}/bookings/{bookingId}',\n method: 'get',\n operationId: 'getBooking',\n summary: 'Retrieve a booking',\n returns: 'Booking',\n pathParams: [\n SITE_ID_PATH_PARAM,\n { name: 'bookingId', description: 'Booking id.' },\n ],\n },\n ],\n}\n"],"names":["booleanField","bool","integerField","int","isoField","iso","nullableField","nullable","objectKindField","OBJECT_FIELD","queryParam","q","stringField","str","SITE_ID_PATH_PARAM","BOOKINGS_API_V1_DESCRIPTION","tag","description","schemaName","required","fields","id","object","serviceId","serviceName","status","type","enum","name","email","phone","address","additionalProperties","startsAt","endsAt","timeZone","currency","paidCents","taxCents","refundedCents","checkedIn","checkedInAt","rescheduledFrom","created","ops","path","method","operationId","summary","list","returns","filters","pathParams"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAEEA,gBAAgBC,IAAI,EACpBC,gBAAgBC,GAAG,EACnBC,YAAYC,GAAG,EACfC,iBAAiBC,QAAQ,EACzBC,mBAAmBC,YAAY,EAC/BC,cAAcC,CAAC,EACfC,eAAeC,GAAG,EAClBC,kBAAkB,QACb,qDAAoD;AAE3D;;;CAGC,GACD,OAAO,MAAMC,8BAAwD;IACnEC,KAAK;IACLC,aAAa;IACbC,YAAY;IACZC,UAAU;QAAC;QAAM;QAAU;KAAS;IACpCC,QAAQ;QACNC,IAAIR,IAAI;QACRS,QAAQb,aAAa;QACrBc,WAAWhB,SAASM,IAAI;QACxBW,aAAajB,SAASM,IAAI;QAC1BY,QAAQ;YACNC,MAAM;YACNC,MAAM;gBAAC;gBAAa;gBAAkB;gBAAW;aAAW;YAC5DV,aACE;QACJ;QACAW,MAAMrB,SAASM,IAAI;QACnBgB,OAAOtB,SAASM,IAAI;QACpBiB,OAAOvB,SAASM,IAAI;QACpBkB,SAAS;YACPL,MAAM;gBAAC;gBAAU;gBAAU;aAAO;YAClCT,aAAa;YACbe,sBAAsB;QACxB;QACAC,UAAU1B,SAASF,IAAI;QACvB6B,QAAQ3B,SAASF,IAAI;QACrB8B,UAAU5B,SAASM,IAAI;QACvBuB,UAAUvB,IAAI;QACdwB,WAAWlC,IAAI;QACfmC,UAAUnC,IAAI;QACdoC,eAAepC,IAAI;QACnBqC,WAAWvC,KAAK;QAChBwC,aAAalC,SAASF,IAAI;QAC1BqC,iBAAiBnC,SAASF,IAAI;QAC9BsC,SAASpC,SAASF,IAAI;IACxB;IACAuC,KAAK;QACH;YACEC,MAAM;YACNC,QAAQ;YACRC,aAAa;YACbC,SAAS;YACTC,MAAM;YACNC,SAAS;YACTC,SAAS;gBACPxC,EAAE,UAAU;gBACZA,EAAE,aAAa;aAChB;YACDyC,YAAY;gBAACtC;aAAmB;QAClC;QACA;YACE+B,MAAM;YACNC,QAAQ;YACRC,aAAa;YACbC,SAAS;YACTE,SAAS;YACTE,YAAY;gBACVtC;gBACA;oBAAEc,MAAM;oBAAaX,aAAa;gBAAc;aACjD;QACH;KACD;AACH,EAAC"}
1
+ {"version":3,"sources":["../../../../../../../../libs/plugins/bookings/src/lib/server/api-v1/openapi.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n type ApiV1ResourceDescription,\n booleanField as bool,\n integerField as int,\n isoField as iso,\n nullableField as nullable,\n objectKindField as OBJECT_FIELD,\n queryParam as q,\n stringField as str,\n SITE_ID_PATH_PARAM,\n} from '@aglyn/tenant-data-admin/server/api-v1-description'\n\n/**\n * A site's bookings as the customer API's OpenAPI document describes them\n * (AGL-3643), in the shape `apps/docs/api/resources/bookings.md` documents.\n */\nexport const BOOKINGS_API_V1_DESCRIPTION: ApiV1ResourceDescription = {\n tag: 'Bookings',\n docsPage: 'bookings',\n description: 'A site’s bookings. Read-only over the API.',\n schemaName: 'Booking',\n required: ['id', 'object', 'status'],\n fields: {\n id: str('Booking id.'),\n object: OBJECT_FIELD('booking'),\n serviceId: nullable(str('The booked service.')),\n serviceName: nullable(str('The service’s name when it was booked.')),\n status: {\n type: 'string',\n enum: ['confirmed', 'pendingPayment', 'expired', 'canceled'],\n description:\n '`pendingPayment` is a paid booking whose checkout is still open; `expired` is one whose checkout ran out, and its slot was released.',\n },\n name: nullable(str('The guest’s name.')),\n email: nullable(str('The guest’s email address.')),\n phone: nullable(str('The guest’s phone number, when the service asked for one.')),\n address: {\n type: ['object', 'string', 'null'],\n description: 'The address the service is at, when the service asked for one: the guest’s address parts, or the line they typed.',\n additionalProperties: true,\n },\n startsAt: nullable(iso('When the booking starts, UTC.')),\n endsAt: nullable(iso('When the booking ends, UTC.')),\n timeZone: nullable(str('The IANA time zone the booking was made in.')),\n currency: str('Always `usd`.'),\n paidCents: int('What the guest paid, tax included; 0 for a free booking.'),\n taxCents: int('The tax inside `paidCents`.'),\n refundedCents: int('Refunded so far.'),\n checkedIn: bool('Whether the guest was checked in.'),\n checkedInAt: nullable(iso('When the guest was checked in.')),\n rescheduledFrom: nullable(iso('Where a moved booking started before its latest move.')),\n created: nullable(iso('When the booking was made.')),\n },\n ops: [\n {\n path: '/v1/sites/{siteId}/bookings',\n method: 'get',\n operationId: 'listBookings',\n summary: 'List a site’s bookings', description: 'Lists the appointments booked on one site, with service, time, customer and status. Needs `siteId` from List sites. Filter by status or service. Read only.',\n list: true,\n returns: 'Booking',\n filters: [\n q('status', '`confirmed`, `pendingPayment` or `canceled`. An expired checkout is stored as `pendingPayment`.'),\n q('serviceId', 'Bookings of one service.'),\n ],\n pathParams: [SITE_ID_PATH_PARAM],\n },\n {\n path: '/v1/sites/{siteId}/bookings/{bookingId}',\n method: 'get',\n operationId: 'getBooking',\n summary: 'Get a booking', description: 'Returns one booking. Needs `siteId` from List sites and `bookingId` from List a site’s bookings.',\n returns: 'Booking',\n pathParams: [\n SITE_ID_PATH_PARAM,\n { name: 'bookingId', description: 'Booking id.' },\n ],\n },\n ],\n}\n"],"names":["booleanField","bool","integerField","int","isoField","iso","nullableField","nullable","objectKindField","OBJECT_FIELD","queryParam","q","stringField","str","SITE_ID_PATH_PARAM","BOOKINGS_API_V1_DESCRIPTION","tag","docsPage","description","schemaName","required","fields","id","object","serviceId","serviceName","status","type","enum","name","email","phone","address","additionalProperties","startsAt","endsAt","timeZone","currency","paidCents","taxCents","refundedCents","checkedIn","checkedInAt","rescheduledFrom","created","ops","path","method","operationId","summary","list","returns","filters","pathParams"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAEEA,gBAAgBC,IAAI,EACpBC,gBAAgBC,GAAG,EACnBC,YAAYC,GAAG,EACfC,iBAAiBC,QAAQ,EACzBC,mBAAmBC,YAAY,EAC/BC,cAAcC,CAAC,EACfC,eAAeC,GAAG,EAClBC,kBAAkB,QACb,qDAAoD;AAE3D;;;CAGC,GACD,OAAO,MAAMC,8BAAwD;IACnEC,KAAK;IACLC,UAAU;IACVC,aAAa;IACbC,YAAY;IACZC,UAAU;QAAC;QAAM;QAAU;KAAS;IACpCC,QAAQ;QACNC,IAAIT,IAAI;QACRU,QAAQd,aAAa;QACrBe,WAAWjB,SAASM,IAAI;QACxBY,aAAalB,SAASM,IAAI;QAC1Ba,QAAQ;YACNC,MAAM;YACNC,MAAM;gBAAC;gBAAa;gBAAkB;gBAAW;aAAW;YAC5DV,aACE;QACJ;QACAW,MAAMtB,SAASM,IAAI;QACnBiB,OAAOvB,SAASM,IAAI;QACpBkB,OAAOxB,SAASM,IAAI;QACpBmB,SAAS;YACPL,MAAM;gBAAC;gBAAU;gBAAU;aAAO;YAClCT,aAAa;YACbe,sBAAsB;QACxB;QACAC,UAAU3B,SAASF,IAAI;QACvB8B,QAAQ5B,SAASF,IAAI;QACrB+B,UAAU7B,SAASM,IAAI;QACvBwB,UAAUxB,IAAI;QACdyB,WAAWnC,IAAI;QACfoC,UAAUpC,IAAI;QACdqC,eAAerC,IAAI;QACnBsC,WAAWxC,KAAK;QAChByC,aAAanC,SAASF,IAAI;QAC1BsC,iBAAiBpC,SAASF,IAAI;QAC9BuC,SAASrC,SAASF,IAAI;IACxB;IACAwC,KAAK;QACH;YACEC,MAAM;YACNC,QAAQ;YACRC,aAAa;YACbC,SAAS;YAA0B/B,aAAa;YAChDgC,MAAM;YACNC,SAAS;YACTC,SAAS;gBACPzC,EAAE,UAAU;gBACZA,EAAE,aAAa;aAChB;YACD0C,YAAY;gBAACvC;aAAmB;QAClC;QACA;YACEgC,MAAM;YACNC,QAAQ;YACRC,aAAa;YACbC,SAAS;YAAiB/B,aAAa;YACvCiC,SAAS;YACTE,YAAY;gBACVvC;gBACA;oBAAEe,MAAM;oBAAaX,aAAa;gBAAc;aACjD;QACH;KACD;AACH,EAAC"}