@anzusystems/common-admin 2.0.0-rc.4 → 2.0.0-rc.6

package/dist/domains/cached/components/ACachedChip.vue.d.ts

@@ -16,18 +16,20 @@ type __VLS_Props = {
     closable?: boolean;
     customTitleFn?: (cachedItem: any, defaultTitle: string, displayTextPath: string, fallbackIdText: boolean) => string | undefined;
 };
-declare var __VLS_1: {}, __VLS_3: {
-    id: string | number;
-}, __VLS_18: {
-    id: string | number;
-};
-type __VLS_Slots = {} & {
-    empty?: (props: typeof __VLS_1) => any;
-} & {
-    unresolved?: (props: typeof __VLS_3) => any;
-} & {
-    unresolved?: (props: typeof __VLS_18) => any;
+declare const __VLS_template: () => {
+    __VLS_Slots: {
+        empty?: (props: {}) => any;
+    } & {
+        unresolved?: (props: {
+            id: string | number;
+        }) => any;
+    } & {
+        unresolved?: (props: {
+            id: string | number;
+        }) => any;
+    };
 };
+type __VLS_Slots = ReturnType<typeof __VLS_template>['__VLS_Slots'];
 declare const __VLS_base: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
     close: (id: string | number | null | undefined) => any;
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{

package/dist/domains/cached/components/ACachedChip.vue_vue_type_script_setup_true_lang.js.map

@@ -1 +1 @@
-{"version":3,"file":"ACachedChip.vue_vue_type_script_setup_true_lang.js","names":["_openBlock","_createElementBlock","_normalizeClass","_unref","_renderSlot","_createTextVNode","_toDisplayString","_Fragment","_createBlock","_component_VProgressCircular","_createCommentVNode","_component_VChip","_withCtx","_component_VTooltip","_withModifiers","_hoisted_1","ACachedChip_vue_vue_type_script_setup_true_lang_default","__emit","props","__props","emit","useI18n","router","useRouter","useCachedItem","linkDisabled","computed","unresolved","containerClassComputed","showUnresolved","displayTitle","cached","customTitle","objectGetValueByPath","onClick","openBlock","createElementBlock","normalizeClass","unref","isNull","isUndefined","renderSlot","_ctx","_cache","createTextVNode","t","toDisplayString","Fragment","loaded","createBlock","VProgressCircular","createCommentVNode","VChip","withCtx","VTooltip","COMMON_CONFIG","withModifiers"],"sources":["../../../../src/domains/cached/components/ACachedChip.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport { computed } from 'vue'\nimport { useI18n } from 'vue-i18n'\nimport { useRouter } from 'vue-router'\nimport type { DocId, IntegerId } from '@/shared/types/common'\nimport { objectGetValueByPath } from '@/shared/utils/object'\nimport { isNull, isUndefined } from '@/shared/utils/common'\nimport { COMMON_CONFIG } from '@/shared/commonConfig'\nimport { useCachedItem } from '@/domains/cached/composables/useCachedItem'\n\nconst props = withDefaults(\n  defineProps<{\n    id?: null | undefined | IntegerId | DocId\n    title?: string\n    containerClass?: undefined | string\n    getCachedFn: (id: any) => any\n    displayTextPath: string\n    route: string\n    disableClick?: boolean\n    openInNew?: boolean\n    size?: string\n    forceRounded?: boolean\n    textOnly?: boolean\n    fallbackIdText?: boolean\n    wrapText?: boolean\n    closable?: boolean\n    customTitleFn?: (\n      cachedItem: any,\n      defaultTitle: string,\n      displayTextPath: string,\n      fallbackIdText: boolean\n    ) => string | undefined\n  }>(),\n  {\n    id: null,\n    title: '',\n    containerClass: 'd-inline-flex',\n    disableClick: false,\n    openInNew: false,\n    size: 'small',\n    forceRounded: false,\n    textOnly: false,\n    fallbackIdText: false,\n    wrapText: false,\n    closable: false,\n    customTitleFn: undefined,\n  }\n)\n\nconst emit = defineEmits<{\n  (e: 'close', id: null | undefined | IntegerId | DocId): void\n}>()\n\nconst { t } = useI18n()\nconst router = useRouter()\nconst { cached, loaded, unresolved } = useCachedItem(() => props.getCachedFn(props.id as any))\n\n// An item the fetch could not resolve has only its placeholder to show: its id, and no link to a\n// detail that would not load either.\nconst linkDisabled = computed(() => props.disableClick || unresolved.value)\n\nconst containerClassComputed = computed(() => {\n  return props.wrapText ? props.containerClass + ' a-chip--wrap' : props.containerClass\n})\n\n// A title given by the caller still wins over the placeholder.\nconst showUnresolved = computed(() => unresolved.value && props.title.length === 0)\n\nconst displayTitle = computed(() => {\n  if (showUnresolved.value) return '#' + props.id\n  if (props.customTitleFn && cached.value) {\n    const customTitle = props.customTitleFn(cached.value, props.title, props.displayTextPath, props.fallbackIdText)\n    if (customTitle !== undefined) {\n      return customTitle\n    }\n  }\n  if (props.title.length > 0) return props.title\n  if (cached.value) {\n    return objectGetValueByPath(cached.value, props.displayTextPath)\n  }\n  return props.fallbackIdText ? props.id : ''\n})\n\nconst onClick = () => {\n  router.push({ name: props.route, params: { id: props.id } })\n}\n</script>\n\n<template>\n  <div :class=\"containerClassComputed\">\n    <template v-if=\"isNull(id) || isUndefined(id)\">\n      <slot name=\"empty\">-</slot>\n    </template>\n    <div\n      v-else-if=\"textOnly\"\n      :title=\"unresolved ? t('common.model.cachedUnavailable') : undefined\"\n    >\n      <slot\n        v-if=\"showUnresolved\"\n        :id=\"id\"\n        name=\"unresolved\"\n      >\n        {{ displayTitle }}\n      </slot>\n      <template v-else>{{ displayTitle }}</template>\n      <VProgressCircular\n        v-if=\"!loaded && title.length === 0\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"mx-1\"\n      />\n    </div>\n    <VChip\n      v-else-if=\"linkDisabled\"\n      :size=\"size\"\n      :label=\"forceRounded ? undefined : true\"\n      :closable=\"closable\"\n      close-label=\"common.button.remove\"\n      @click:close=\"() => emit('close', id)\"\n    >\n      <slot\n        v-if=\"showUnresolved\"\n        :id=\"id\"\n        name=\"unresolved\"\n      >\n        {{ displayTitle }}\n      </slot>\n      <template v-else>{{ displayTitle }}</template>\n      <VTooltip\n        v-if=\"unresolved\"\n        activator=\"parent\"\n        location=\"bottom\"\n      >\n        {{ t('common.model.cachedUnavailable') }}\n      </VTooltip>\n      <VProgressCircular\n        v-if=\"!loaded && title.length === 0\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"mx-1\"\n      />\n    </VChip>\n    <VChip\n      v-else\n      :size=\"size\"\n      :append-icon=\"openInNew ? COMMON_CONFIG.CHIP.ICON.LINK_EXTERNAL : COMMON_CONFIG.CHIP.ICON.LINK\"\n      :label=\"forceRounded ? undefined : true\"\n      :closable=\"closable\"\n      close-label=\"common.button.remove\"\n      @click.stop=\"onClick\"\n      @click:close=\"() => emit('close', id)\"\n    >\n      {{ displayTitle }}\n      <VProgressCircular\n        v-if=\"!loaded && title.length === 0\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"mx-1\"\n      />\n    </VChip>\n  </div>\n</template>\n\n<style lang=\"scss\">\n.a-chip--wrap {\n  .v-chip {\n    height: auto !important;\n  }\n\n  .v-chip .v-chip__content {\n    max-width: 100%;\n    height: auto;\n    min-height: 26px;\n    white-space: pre-wrap;\n  }\n}\n</style>\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUA,IAAMkB,IAAQC,GAuCRC,IAAOH,GAIP,EAAE,SAAMI,EAAQ,GAChBC,IAASC,EAAU,GACnB,EAAE,WAAQ,WAAQ,kBAAeC,QAAoBN,EAAM,YAAYA,EAAM,EAAS,CAAC,GAIvFO,IAAeC,QAAeR,EAAM,gBAAgBS,EAAW,KAAK,GAEpEC,IAAyBF,QACtBR,EAAM,WAAWA,EAAM,iBAAiB,kBAAkBA,EAAM,cACxE,GAGKW,IAAiBH,QAAeC,EAAW,SAAST,EAAM,MAAM,WAAW,CAAC,GAE5EY,IAAeJ,QAAe;GAClC,IAAIG,EAAe,OAAO,OAAO,MAAMX,EAAM;GAC7C,IAAIA,EAAM,iBAAiBa,EAAO,OAAO;IACvC,IAAMC,IAAcd,EAAM,cAAca,EAAO,OAAOb,EAAM,OAAOA,EAAM,iBAAiBA,EAAM,cAAc;IAC9G,IAAIc,MAAgB,KAAA,GAClB,OAAOA;GAEX;GAKA,OAJId,EAAM,MAAM,SAAS,IAAUA,EAAM,QACrCa,EAAO,QACFE,EAAqBF,EAAO,OAAOb,EAAM,eAAe,IAE1DA,EAAM,iBAAiBA,EAAM,KAAK;EAC3C,CAAC,GAEKgB,UAAgB;GACpB,EAAO,KAAK;IAAE,MAAMhB,EAAM;IAAO,QAAQ,EAAE,IAAIA,EAAM,GAAG;GAAE,CAAC;EAC7D;E,kBAIElB,EAAA,GAAAC,EA0EM,OAAA,EA1EA,OAAKC,EAAE0B,EAAA,KAAsB,E,IACjBzB,EAAAoC,CAAA,CAAM,CAACpB,EAAA,EAAE,KAAKhB,EAAAqC,CAAA,CAAW,CAACrB,EAAA,EAAE,IAC1Cf,EAA2BsC,EAAA,QAAA,SAAA,CAAA,SAAA,CAAR,AAAAC,EAAA,OAAAtC,EAAA,KAAC,EAAA,C,gBAGTc,EAAA,YADbnB,EAAA,GAAAC,EAmBM,OAAA;;GAjBH,OAAOE,EAAAwB,CAAA,IAAaxB,EAAA0C,CAAA,CAAC,CAAA,gCAAA,IAAqC,KAAA;E,IAGnDhB,EAAA,QADRzB,EAMOsC,EAAA,QAAA,cAAA,EAJJ,IAAIvB,EAAA,GAAE,SAIF,CADFd,EAAAC,EAAAwB,EAAA,KAAY,GAAA,CAAA,C,iBAEjB9B,EAAA,GAAAC,EAA8CM,GAAA,EAAA,KAAA,EAAA,GAAA,CAA1BF,EAAAC,EAAAwB,EAAA,KAAY,GAAA,CAAA,C,SAEvB,CAAA3B,EAAA6C,CAAA,KAAU7B,EAAA,MAAM,WAAM,KAD/BnB,EAAA,GAAAQ,EAMEC,GAAA;;GAJC,MAAM;GACN,OAAO;GACR,eAAA;GACA,OAAM;E,2BAIGgB,EAAA,SADbzB,EAAA,GAAAQ,EA8BQG,GAAA;;GA5BL,MAAMQ,EAAA;GACN,OAAO,GAAA,gBAAe,KAAA;GACtB,UAAUA,EAAA;GACX,eAAY;GACX,iBAAW,AAAAwB,EAAA,aAAQvB,EAAI,SAAUD,EAAA,EAAE;;GAEpC,SAAAP,QAMO;IALCiB,EAAA,QADRzB,EAMOsC,EAAA,QAAA,cAAA,EAJJ,IAAIvB,EAAA,GAAE,SAIF,CADFd,EAAAC,EAAAwB,EAAA,KAAY,GAAA,CAAA,C,iBAEjB9B,EAAA,GAAAC,EAA8CM,GAAA,EAAA,KAAA,EAAA,GAAA,CAA1BF,EAAAC,EAAAwB,EAAA,KAAY,GAAA,CAAA,C;IAExB3B,EAAAwB,CAAA,KADR3B,EAAA,GAAAQ,EAMWK,GAAA;;KAJT,WAAU;KACV,UAAS;;KAET,SAAAD,QAAyC,CAAtCP,EAAAC,EAAAH,EAAA0C,CAAA,CAAC,CAAA,gCAAA,CAAA,GAAA,CAAA,C;;;IAGG,CAAA1C,EAAA6C,CAAA,KAAU7B,EAAA,MAAM,WAAM,KAD/BnB,EAAA,GAAAQ,EAMEC,GAAA;;KAJC,MAAM;KACN,OAAO;KACR,eAAA;KACA,OAAM;;;;;;;;E,OAGVT,EAAA,GAAAQ,EAkBQG,GAAA;;GAhBL,MAAMQ,EAAA;GACN,eAAaA,EAAA,YAAYhB,EAAAoD,CAAA,CAAa,CAAC,KAAK,KAAK,gBAAgBpD,EAAAoD,CAAA,CAAa,CAAC,KAAK,KAAK;GACzF,OAAO,GAAA,gBAAe,KAAA;GACtB,UAAUpC,EAAA;GACX,eAAY;GACX,SAAKL,EAAOoB,GAAO,CAAA,MAAA,CAAA;GACnB,iBAAW,AAAAS,EAAA,aAAQvB,EAAI,SAAUD,EAAA,EAAE;;GAEpC,SAAAP,QAAkB,CAAfP,EAAAC,EAAAwB,EAAA,KAAY,IAAG,KAClB,CAAA,GACS,CAAA3B,EAAA6C,CAAA,KAAU7B,EAAA,MAAM,WAAM,KAD/BnB,EAAA,GAAAQ,EAMEC,GAAA;;IAJC,MAAM;IACN,OAAO;IACR,eAAA;IACA,OAAM"}
+{"version":3,"file":"ACachedChip.vue_vue_type_script_setup_true_lang.js","names":["_openBlock","_createElementBlock","_normalizeClass","_unref","_renderSlot","_createTextVNode","_toDisplayString","_Fragment","_createBlock","_component_VProgressCircular","_createCommentVNode","_component_VChip","_withCtx","_component_VTooltip","_withModifiers","_hoisted_1","ACachedChip_vue_vue_type_script_setup_true_lang_default","__emit","props","__props","emit","useI18n","router","useRouter","useCachedItem","linkDisabled","computed","unresolved","containerClassComputed","showUnresolved","displayTitle","cached","customTitle","objectGetValueByPath","onClick","openBlock","createElementBlock","normalizeClass","unref","isNull","isUndefined","renderSlot","_ctx","_cache","createTextVNode","t","toDisplayString","Fragment","loaded","createBlock","VProgressCircular","createCommentVNode","VChip","withCtx","VTooltip","COMMON_CONFIG","withModifiers"],"sources":["../../../../src/domains/cached/components/ACachedChip.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport { computed } from 'vue'\nimport { useI18n } from 'vue-i18n'\nimport { useRouter } from 'vue-router'\nimport type { DocId, IntegerId } from '@/shared/types/common'\nimport { objectGetValueByPath } from '@/shared/utils/object'\nimport { isNull, isUndefined } from '@/shared/utils/common'\nimport { COMMON_CONFIG } from '@/shared/commonConfig'\nimport { useCachedItem } from '@/domains/cached/composables/useCachedItem'\n\nconst props = withDefaults(\n  defineProps<{\n    id?: null | undefined | IntegerId | DocId\n    title?: string\n    containerClass?: undefined | string\n    getCachedFn: (id: any) => any\n    displayTextPath: string\n    route: string\n    disableClick?: boolean\n    openInNew?: boolean\n    size?: string\n    forceRounded?: boolean\n    textOnly?: boolean\n    fallbackIdText?: boolean\n    wrapText?: boolean\n    closable?: boolean\n    customTitleFn?: (\n      cachedItem: any,\n      defaultTitle: string,\n      displayTextPath: string,\n      fallbackIdText: boolean\n    ) => string | undefined\n  }>(),\n  {\n    id: null,\n    title: '',\n    containerClass: 'd-inline-flex',\n    disableClick: false,\n    openInNew: false,\n    size: 'small',\n    forceRounded: false,\n    textOnly: false,\n    fallbackIdText: false,\n    wrapText: false,\n    closable: false,\n    customTitleFn: undefined,\n  }\n)\n\nconst emit = defineEmits<{\n  (e: 'close', id: null | undefined | IntegerId | DocId): void\n}>()\n\nconst { t } = useI18n()\nconst router = useRouter()\nconst { cached, loaded, unresolved } = useCachedItem(() => props.getCachedFn(props.id as any))\n\n// An item the fetch could not resolve shows only its id placeholder.\n// It gets no link, because its detail would not load either.\nconst linkDisabled = computed(() => props.disableClick || unresolved.value)\n\nconst containerClassComputed = computed(() => {\n  return props.wrapText ? props.containerClass + ' a-chip--wrap' : props.containerClass\n})\n\n// A title given by the caller still wins over the placeholder.\nconst showUnresolved = computed(() => unresolved.value && props.title.length === 0)\n\nconst displayTitle = computed(() => {\n  if (showUnresolved.value) return '#' + props.id\n  if (props.customTitleFn && cached.value) {\n    const customTitle = props.customTitleFn(cached.value, props.title, props.displayTextPath, props.fallbackIdText)\n    if (customTitle !== undefined) {\n      return customTitle\n    }\n  }\n  if (props.title.length > 0) return props.title\n  if (cached.value) {\n    return objectGetValueByPath(cached.value, props.displayTextPath)\n  }\n  return props.fallbackIdText ? props.id : ''\n})\n\nconst onClick = () => {\n  router.push({ name: props.route, params: { id: props.id } })\n}\n</script>\n\n<template>\n  <div :class=\"containerClassComputed\">\n    <template v-if=\"isNull(id) || isUndefined(id)\">\n      <slot name=\"empty\">-</slot>\n    </template>\n    <div\n      v-else-if=\"textOnly\"\n      :title=\"unresolved ? t('common.model.cachedUnavailable') : undefined\"\n    >\n      <slot\n        v-if=\"showUnresolved\"\n        :id=\"id\"\n        name=\"unresolved\"\n      >\n        {{ displayTitle }}\n      </slot>\n      <template v-else>{{ displayTitle }}</template>\n      <VProgressCircular\n        v-if=\"!loaded && title.length === 0\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"mx-1\"\n      />\n    </div>\n    <VChip\n      v-else-if=\"linkDisabled\"\n      :size=\"size\"\n      :label=\"forceRounded ? undefined : true\"\n      :closable=\"closable\"\n      close-label=\"common.button.remove\"\n      @click:close=\"() => emit('close', id)\"\n    >\n      <slot\n        v-if=\"showUnresolved\"\n        :id=\"id\"\n        name=\"unresolved\"\n      >\n        {{ displayTitle }}\n      </slot>\n      <template v-else>{{ displayTitle }}</template>\n      <VTooltip\n        v-if=\"unresolved\"\n        activator=\"parent\"\n        location=\"bottom\"\n      >\n        {{ t('common.model.cachedUnavailable') }}\n      </VTooltip>\n      <VProgressCircular\n        v-if=\"!loaded && title.length === 0\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"mx-1\"\n      />\n    </VChip>\n    <VChip\n      v-else\n      :size=\"size\"\n      :append-icon=\"openInNew ? COMMON_CONFIG.CHIP.ICON.LINK_EXTERNAL : COMMON_CONFIG.CHIP.ICON.LINK\"\n      :label=\"forceRounded ? undefined : true\"\n      :closable=\"closable\"\n      close-label=\"common.button.remove\"\n      @click.stop=\"onClick\"\n      @click:close=\"() => emit('close', id)\"\n    >\n      {{ displayTitle }}\n      <VProgressCircular\n        v-if=\"!loaded && title.length === 0\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"mx-1\"\n      />\n    </VChip>\n  </div>\n</template>\n\n<style lang=\"scss\">\n.a-chip--wrap {\n  .v-chip {\n    height: auto !important;\n  }\n\n  .v-chip .v-chip__content {\n    max-width: 100%;\n    height: auto;\n    min-height: 26px;\n    white-space: pre-wrap;\n  }\n}\n</style>\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAUA,IAAMkB,IAAQC,GAuCRC,IAAOH,GAIP,EAAE,SAAMI,EAAQ,GAChBC,IAASC,EAAU,GACnB,EAAE,WAAQ,WAAQ,kBAAeC,QAAoBN,EAAM,YAAYA,EAAM,EAAS,CAAC,GAIvFO,IAAeC,QAAeR,EAAM,gBAAgBS,EAAW,KAAK,GAEpEC,IAAyBF,QACtBR,EAAM,WAAWA,EAAM,iBAAiB,kBAAkBA,EAAM,cACxE,GAGKW,IAAiBH,QAAeC,EAAW,SAAST,EAAM,MAAM,WAAW,CAAC,GAE5EY,IAAeJ,QAAe;GAClC,IAAIG,EAAe,OAAO,OAAO,MAAMX,EAAM;GAC7C,IAAIA,EAAM,iBAAiBa,EAAO,OAAO;IACvC,IAAMC,IAAcd,EAAM,cAAca,EAAO,OAAOb,EAAM,OAAOA,EAAM,iBAAiBA,EAAM,cAAc;IAC9G,IAAIc,MAAgB,KAAA,GAClB,OAAOA;GAEX;GAKA,OAJId,EAAM,MAAM,SAAS,IAAUA,EAAM,QACrCa,EAAO,QACFE,EAAqBF,EAAO,OAAOb,EAAM,eAAe,IAE1DA,EAAM,iBAAiBA,EAAM,KAAK;EAC3C,CAAC,GAEKgB,UAAgB;GACpB,EAAO,KAAK;IAAE,MAAMhB,EAAM;IAAO,QAAQ,EAAE,IAAIA,EAAM,GAAG;GAAE,CAAC;EAC7D;E,kBAIElB,EAAA,GAAAC,EA0EM,OAAA,EA1EA,OAAKC,EAAE0B,EAAA,KAAsB,E,IACjBzB,EAAAoC,CAAA,CAAM,CAACpB,EAAA,EAAE,KAAKhB,EAAAqC,CAAA,CAAW,CAACrB,EAAA,EAAE,IAC1Cf,EAA2BsC,EAAA,QAAA,SAAA,CAAA,SAAA,CAAR,AAAAC,EAAA,OAAAtC,EAAA,KAAC,EAAA,C,gBAGTc,EAAA,YADbnB,EAAA,GAAAC,EAmBM,OAAA;;GAjBH,OAAOE,EAAAwB,CAAA,IAAaxB,EAAA0C,CAAA,CAAC,CAAA,gCAAA,IAAqC,KAAA;E,IAGnDhB,EAAA,QADRzB,EAMOsC,EAAA,QAAA,cAAA,EAJJ,IAAIvB,EAAA,GAAE,SAIF,CADFd,EAAAC,EAAAwB,EAAA,KAAY,GAAA,CAAA,C,iBAEjB9B,EAAA,GAAAC,EAA8CM,GAAA,EAAA,KAAA,EAAA,GAAA,CAA1BF,EAAAC,EAAAwB,EAAA,KAAY,GAAA,CAAA,C,SAEvB,CAAA3B,EAAA6C,CAAA,KAAU7B,EAAA,MAAM,WAAM,KAD/BnB,EAAA,GAAAQ,EAMEC,GAAA;;GAJC,MAAM;GACN,OAAO;GACR,eAAA;GACA,OAAM;E,2BAIGgB,EAAA,SADbzB,EAAA,GAAAQ,EA8BQG,GAAA;;GA5BL,MAAMQ,EAAA;GACN,OAAO,GAAA,gBAAe,KAAA;GACtB,UAAUA,EAAA;GACX,eAAY;GACX,iBAAW,AAAAwB,EAAA,aAAQvB,EAAI,SAAUD,EAAA,EAAE;;GAEpC,SAAAP,QAMO;IALCiB,EAAA,QADRzB,EAMOsC,EAAA,QAAA,cAAA,EAJJ,IAAIvB,EAAA,GAAE,SAIF,CADFd,EAAAC,EAAAwB,EAAA,KAAY,GAAA,CAAA,C,iBAEjB9B,EAAA,GAAAC,EAA8CM,GAAA,EAAA,KAAA,EAAA,GAAA,CAA1BF,EAAAC,EAAAwB,EAAA,KAAY,GAAA,CAAA,C;IAExB3B,EAAAwB,CAAA,KADR3B,EAAA,GAAAQ,EAMWK,GAAA;;KAJT,WAAU;KACV,UAAS;;KAET,SAAAD,QAAyC,CAAtCP,EAAAC,EAAAH,EAAA0C,CAAA,CAAC,CAAA,gCAAA,CAAA,GAAA,CAAA,C;;;IAGG,CAAA1C,EAAA6C,CAAA,KAAU7B,EAAA,MAAM,WAAM,KAD/BnB,EAAA,GAAAQ,EAMEC,GAAA;;KAJC,MAAM;KACN,OAAO;KACR,eAAA;KACA,OAAM;;;;;;;;E,OAGVT,EAAA,GAAAQ,EAkBQG,GAAA;;GAhBL,MAAMQ,EAAA;GACN,eAAaA,EAAA,YAAYhB,EAAAoD,CAAA,CAAa,CAAC,KAAK,KAAK,gBAAgBpD,EAAAoD,CAAA,CAAa,CAAC,KAAK,KAAK;GACzF,OAAO,GAAA,gBAAe,KAAA;GACtB,UAAUpC,EAAA;GACX,eAAY;GACX,SAAKL,EAAOoB,GAAO,CAAA,MAAA,CAAA;GACnB,iBAAW,AAAAS,EAAA,aAAQvB,EAAI,SAAUD,EAAA,EAAE;;GAEpC,SAAAP,QAAkB,CAAfP,EAAAC,EAAAwB,EAAA,KAAY,IAAG,KAClB,CAAA,GACS,CAAA3B,EAAA6C,CAAA,KAAU7B,EAAA,MAAM,WAAM,KAD/BnB,EAAA,GAAAQ,EAMEC,GAAA;;IAJC,MAAM;IACN,OAAO;IACR,eAAA;IACA,OAAM"}

package/dist/domains/cached/components/ACachedUserChip.js

@@ -2,7 +2,7 @@ import e from "../../../_virtual/_plugin-vue_export-helper.js";
 import t from "./ACachedUserChip.vue_vue_type_script_setup_true_lang.js";
 /* empty css                                                                */
 // src/domains/cached/components/ACachedUserChip.vue
-var n = /*#__PURE__*/ e(t, [["__scopeId", "data-v-c7614d6b"]]);
+var n = /*#__PURE__*/ e(t, [["__scopeId", "data-v-c2700907"]]);
 export { n as default };
 
 //# sourceMappingURL=ACachedUserChip.js.map

package/dist/domains/cached/components/ACachedUserChip.js.map

@@ -1 +1 @@
-{"version":3,"file":"ACachedUserChip.js","names":["_sfc_main","_plugin_vue_export_helper_default","ACachedUserChip_vue_vue_type_script_setup_true_lang_default","ACachedUserChip_default"],"sources":["../../../../src/domains/cached/components/ACachedUserChip.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport type { IntegerIdNullable } from '@/shared/types/common'\nimport { computed } from 'vue'\nimport { useI18n } from 'vue-i18n'\nimport { useRouter } from 'vue-router'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport type { CachedItem } from '@/domains/cached/composables/defineCached'\nimport { COMMON_CONFIG } from '@/shared/commonConfig'\nimport AAnzuUserAvatar from '@/domains/ui/components/AAnzuUserAvatar.vue'\nimport { replaceUrlParameters } from '@/domains/api/utils/apiHelper'\nimport { useCachedItem } from '@/domains/cached/composables/useCachedItem'\n\nconst props = withDefaults(\n  defineProps<{\n    id: IntegerIdNullable | undefined\n    /** The admin's cache getter, e.g. `getCachedUser` of its `useCachedUsers()`. */\n    getCachedFn: (id: IntegerIdNullable | undefined) => CachedItem<AnzuUserMinimal> | undefined\n    routeName?: string | undefined\n    externalUrlTemplate?: string | undefined\n    /**\n     * The label, for a cache whose users carry a better one than `person.fullName` (a nickname). `any`,\n     * because it reads the admin's own user, which `AnzuUserMinimal` does not describe.\n     */\n    titleFn?: ((user: CachedItem<any>) => string) | undefined\n    disableClick?: boolean\n    /** The name of the close, where Vuetify's defaults make the chip closable: \"Remove\", unless the admin names it. */\n    closeLabel?: string\n  }>(),\n  {\n    routeName: undefined,\n    externalUrlTemplate: undefined,\n    titleFn: undefined,\n    disableClick: false,\n    closeLabel: 'common.button.remove',\n  }\n)\n\nconst { t } = useI18n()\nconst router = useRouter()\n// 0 counts as no id, as it does in `defineCached`: a blank factory record carries it.\nconst { cached, loaded, unresolved } = useCachedItem(() => (props.id ? props.getCachedFn(props.id) : undefined))\n\n// Optional chaining on purpose: each admin maps its own users into the cache, and a mapper that\n// leaves the name or the e-mail out falls through to the next label instead of throwing.\nconst text = computed(() => {\n  const user = cached.value\n  if (!user) return ''\n  const title = props.titleFn ? props.titleFn(user) : ''\n  if (title) return title\n  if (user.person?.fullName) return user.person.fullName\n  if (user.email) return user.email.split('@')[0]\n  return '#' + props.id\n})\n\nconst clickable = computed(\n  () => !props.disableClick && !unresolved.value && !!(props.externalUrlTemplate || props.routeName)\n)\n\nconst appendIcon = computed(() => {\n  if (!clickable.value) return undefined\n  return props.externalUrlTemplate ? COMMON_CONFIG.CHIP.ICON.LINK_EXTERNAL : COMMON_CONFIG.CHIP.ICON.LINK\n})\n\nconst onClick = () => {\n  if (!clickable.value || !props.id) return\n  if (props.externalUrlTemplate) {\n    window.open(replaceUrlParameters(props.externalUrlTemplate, { id: props.id }), '_blank')\n    return\n  }\n  if (props.routeName) router.push({ name: props.routeName, params: { id: props.id } })\n}\n</script>\n\n<template>\n  <div class=\"d-inline-flex\">\n    <span v-if=\"!id\">-</span>\n    <VChip\n      v-else-if=\"unresolved\"\n      class=\"non-clickable\"\n      size=\"small\"\n      :close-label=\"closeLabel\"\n      data-cy=\"cached-user-chip-unresolved\"\n    >\n      #{{ id }}\n      <VTooltip\n        activator=\"parent\"\n        location=\"bottom\"\n      >\n        {{ t('common.model.tracking.userUnavailable') }}\n      </VTooltip>\n    </VChip>\n    <VChip\n      v-else\n      class=\"pl-1\"\n      :class=\"clickable ? '' : 'non-clickable'\"\n      size=\"small\"\n      :append-icon=\"appendIcon\"\n      :close-label=\"closeLabel\"\n      @click.stop=\"onClick\"\n    >\n      <AAnzuUserAvatar\n        v-if=\"loaded\"\n        :user=\"cached\"\n        container-class=\"mr-1\"\n        :size=\"20\"\n      />\n      {{ text }}\n      <VProgressCircular\n        v-if=\"!loaded\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"ml-1\"\n      />\n    </VChip>\n  </div>\n</template>\n\n<style lang=\"scss\" scoped>\n.non-clickable {\n  cursor: default;\n}\n</style>\n"],"mappings":""}
+{"version":3,"file":"ACachedUserChip.js","names":["_sfc_main","_plugin_vue_export_helper_default","ACachedUserChip_vue_vue_type_script_setup_true_lang_default","ACachedUserChip_default"],"sources":["../../../../src/domains/cached/components/ACachedUserChip.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport type { IntegerIdNullable } from '@/shared/types/common'\nimport { computed } from 'vue'\nimport { useI18n } from 'vue-i18n'\nimport { useRouter } from 'vue-router'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport type { CachedItem } from '@/domains/cached/composables/defineCached'\nimport { COMMON_CONFIG } from '@/shared/commonConfig'\nimport AAnzuUserAvatar from '@/domains/ui/components/AAnzuUserAvatar.vue'\nimport { replaceUrlParameters } from '@/domains/api/utils/apiHelper'\nimport { useCachedItem } from '@/domains/cached/composables/useCachedItem'\n\nconst props = withDefaults(\n  defineProps<{\n    id: IntegerIdNullable | undefined\n    /** The admin's cache getter, e.g. `getCachedUser` of its `useCachedUsers()`. */\n    getCachedFn: (id: IntegerIdNullable | undefined) => CachedItem<AnzuUserMinimal> | undefined\n    routeName?: string | undefined\n    externalUrlTemplate?: string | undefined\n    /**\n     * Label for caches whose users carry a better one than `person.fullName`, such as a nickname.\n     * `any` because it reads the admin's own user type, which `AnzuUserMinimal` does not describe.\n     */\n    titleFn?: ((user: CachedItem<any>) => string) | undefined\n    disableClick?: boolean\n    /** Label of the close button when Vuetify defaults make the chip closable. Defaults to \"Remove\". */\n    closeLabel?: string\n  }>(),\n  {\n    routeName: undefined,\n    externalUrlTemplate: undefined,\n    titleFn: undefined,\n    disableClick: false,\n    closeLabel: 'common.button.remove',\n  }\n)\n\nconst { t } = useI18n()\nconst router = useRouter()\n// 0 counts as no id, as in `defineCached`. A blank factory record carries it.\nconst { cached, loaded, unresolved } = useCachedItem(() => (props.id ? props.getCachedFn(props.id) : undefined))\n\n// Optional chaining on purpose. Each admin maps its own users into the cache.\n// A mapper that omits the name or e-mail falls through to the next label instead of throwing.\nconst text = computed(() => {\n  const user = cached.value\n  if (!user) return ''\n  const title = props.titleFn ? props.titleFn(user) : ''\n  if (title) return title\n  if (user.person?.fullName) return user.person.fullName\n  if (user.email) return user.email.split('@')[0]\n  return '#' + props.id\n})\n\nconst clickable = computed(\n  () => !props.disableClick && !unresolved.value && !!(props.externalUrlTemplate || props.routeName)\n)\n\nconst appendIcon = computed(() => {\n  if (!clickable.value) return undefined\n  return props.externalUrlTemplate ? COMMON_CONFIG.CHIP.ICON.LINK_EXTERNAL : COMMON_CONFIG.CHIP.ICON.LINK\n})\n\nconst onClick = () => {\n  if (!clickable.value || !props.id) return\n  if (props.externalUrlTemplate) {\n    window.open(replaceUrlParameters(props.externalUrlTemplate, { id: props.id }), '_blank')\n    return\n  }\n  if (props.routeName) router.push({ name: props.routeName, params: { id: props.id } })\n}\n</script>\n\n<template>\n  <div class=\"d-inline-flex\">\n    <span v-if=\"!id\">-</span>\n    <VChip\n      v-else-if=\"unresolved\"\n      class=\"non-clickable\"\n      size=\"small\"\n      :close-label=\"closeLabel\"\n      data-cy=\"cached-user-chip-unresolved\"\n    >\n      #{{ id }}\n      <VTooltip\n        activator=\"parent\"\n        location=\"bottom\"\n      >\n        {{ t('common.model.tracking.userUnavailable') }}\n      </VTooltip>\n    </VChip>\n    <VChip\n      v-else\n      class=\"pl-1\"\n      :class=\"clickable ? '' : 'non-clickable'\"\n      size=\"small\"\n      :append-icon=\"appendIcon\"\n      :close-label=\"closeLabel\"\n      @click.stop=\"onClick\"\n    >\n      <AAnzuUserAvatar\n        v-if=\"loaded\"\n        :user=\"cached\"\n        container-class=\"mr-1\"\n        :size=\"20\"\n      />\n      {{ text }}\n      <VProgressCircular\n        v-if=\"!loaded\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"ml-1\"\n      />\n    </VChip>\n  </div>\n</template>\n\n<style lang=\"scss\" scoped>\n.non-clickable {\n  cursor: default;\n}\n</style>\n"],"mappings":""}

package/dist/domains/cached/components/ACachedUserChip.vue.d.ts

@@ -8,12 +8,12 @@ type __VLS_Props = {
     routeName?: string | undefined;
     externalUrlTemplate?: string | undefined;
     /**
-     * The label, for a cache whose users carry a better one than `person.fullName` (a nickname). `any`,
-     * because it reads the admin's own user, which `AnzuUserMinimal` does not describe.
+     * Label for caches whose users carry a better one than `person.fullName`, such as a nickname.
+     * `any` because it reads the admin's own user type, which `AnzuUserMinimal` does not describe.
      */
     titleFn?: ((user: CachedItem<any>) => string) | undefined;
     disableClick?: boolean;
-    /** The name of the close, where Vuetify's defaults make the chip closable: "Remove", unless the admin names it. */
+    /** Label of the close button when Vuetify defaults make the chip closable. Defaults to "Remove". */
     closeLabel?: string;
 };
 declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {

package/dist/domains/cached/components/ACachedUserChip.vue_vue_type_script_setup_true_lang.js.map

@@ -1 +1 @@
-{"version":3,"file":"ACachedUserChip.vue_vue_type_script_setup_true_lang.js","names":["_openBlock","_createElementBlock","_unref","_createBlock","_component_VChip","_withCtx","_createTextVNode","_toDisplayString","_createVNode","_component_VTooltip","_normalizeClass","_withModifiers","AAnzuUserAvatar","_createCommentVNode","_component_VProgressCircular","AAnzuUserAvatar_default","_hoisted_1","_hoisted_2","ACachedUserChip_vue_vue_type_script_setup_true_lang_default","props","__props","useI18n","router","useRouter","useCachedItem","text","computed","user","cached","clickable","unresolved","appendIcon","COMMON_CONFIG","onClick","replaceUrlParameters","openBlock","createElementBlock","unref","createBlock","VChip","withCtx","createTextVNode","toDisplayString","createVNode","VTooltip","t","normalizeClass","withModifiers","loaded","createCommentVNode","VProgressCircular"],"sources":["../../../../src/domains/cached/components/ACachedUserChip.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport type { IntegerIdNullable } from '@/shared/types/common'\nimport { computed } from 'vue'\nimport { useI18n } from 'vue-i18n'\nimport { useRouter } from 'vue-router'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport type { CachedItem } from '@/domains/cached/composables/defineCached'\nimport { COMMON_CONFIG } from '@/shared/commonConfig'\nimport AAnzuUserAvatar from '@/domains/ui/components/AAnzuUserAvatar.vue'\nimport { replaceUrlParameters } from '@/domains/api/utils/apiHelper'\nimport { useCachedItem } from '@/domains/cached/composables/useCachedItem'\n\nconst props = withDefaults(\n  defineProps<{\n    id: IntegerIdNullable | undefined\n    /** The admin's cache getter, e.g. `getCachedUser` of its `useCachedUsers()`. */\n    getCachedFn: (id: IntegerIdNullable | undefined) => CachedItem<AnzuUserMinimal> | undefined\n    routeName?: string | undefined\n    externalUrlTemplate?: string | undefined\n    /**\n     * The label, for a cache whose users carry a better one than `person.fullName` (a nickname). `any`,\n     * because it reads the admin's own user, which `AnzuUserMinimal` does not describe.\n     */\n    titleFn?: ((user: CachedItem<any>) => string) | undefined\n    disableClick?: boolean\n    /** The name of the close, where Vuetify's defaults make the chip closable: \"Remove\", unless the admin names it. */\n    closeLabel?: string\n  }>(),\n  {\n    routeName: undefined,\n    externalUrlTemplate: undefined,\n    titleFn: undefined,\n    disableClick: false,\n    closeLabel: 'common.button.remove',\n  }\n)\n\nconst { t } = useI18n()\nconst router = useRouter()\n// 0 counts as no id, as it does in `defineCached`: a blank factory record carries it.\nconst { cached, loaded, unresolved } = useCachedItem(() => (props.id ? props.getCachedFn(props.id) : undefined))\n\n// Optional chaining on purpose: each admin maps its own users into the cache, and a mapper that\n// leaves the name or the e-mail out falls through to the next label instead of throwing.\nconst text = computed(() => {\n  const user = cached.value\n  if (!user) return ''\n  const title = props.titleFn ? props.titleFn(user) : ''\n  if (title) return title\n  if (user.person?.fullName) return user.person.fullName\n  if (user.email) return user.email.split('@')[0]\n  return '#' + props.id\n})\n\nconst clickable = computed(\n  () => !props.disableClick && !unresolved.value && !!(props.externalUrlTemplate || props.routeName)\n)\n\nconst appendIcon = computed(() => {\n  if (!clickable.value) return undefined\n  return props.externalUrlTemplate ? COMMON_CONFIG.CHIP.ICON.LINK_EXTERNAL : COMMON_CONFIG.CHIP.ICON.LINK\n})\n\nconst onClick = () => {\n  if (!clickable.value || !props.id) return\n  if (props.externalUrlTemplate) {\n    window.open(replaceUrlParameters(props.externalUrlTemplate, { id: props.id }), '_blank')\n    return\n  }\n  if (props.routeName) router.push({ name: props.routeName, params: { id: props.id } })\n}\n</script>\n\n<template>\n  <div class=\"d-inline-flex\">\n    <span v-if=\"!id\">-</span>\n    <VChip\n      v-else-if=\"unresolved\"\n      class=\"non-clickable\"\n      size=\"small\"\n      :close-label=\"closeLabel\"\n      data-cy=\"cached-user-chip-unresolved\"\n    >\n      #{{ id }}\n      <VTooltip\n        activator=\"parent\"\n        location=\"bottom\"\n      >\n        {{ t('common.model.tracking.userUnavailable') }}\n      </VTooltip>\n    </VChip>\n    <VChip\n      v-else\n      class=\"pl-1\"\n      :class=\"clickable ? '' : 'non-clickable'\"\n      size=\"small\"\n      :append-icon=\"appendIcon\"\n      :close-label=\"closeLabel\"\n      @click.stop=\"onClick\"\n    >\n      <AAnzuUserAvatar\n        v-if=\"loaded\"\n        :user=\"cached\"\n        container-class=\"mr-1\"\n        :size=\"20\"\n      />\n      {{ text }}\n      <VProgressCircular\n        v-if=\"!loaded\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"ml-1\"\n      />\n    </VChip>\n  </div>\n</template>\n\n<style lang=\"scss\" scoped>\n.non-clickable {\n  cursor: default;\n}\n</style>\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYA,IAAMmB,IAAQC,GAyBR,EAAE,SAAMC,EAAQ,GAChBC,IAASC,EAAU,GAEnB,EAAE,WAAQ,WAAQ,kBAAeC,QAAqBL,EAAM,KAAKA,EAAM,YAAYA,EAAM,EAAE,IAAI,KAAA,CAAU,GAIzGM,IAAOC,QAAe;GAC1B,IAAMC,IAAOC,EAAO;GAMpB,OALKD,KACSR,EAAM,UAAUA,EAAM,QAAQQ,CAAI,IAAI,QAEhDA,EAAK,QAAQ,WAAiBA,EAAK,OAAO,WAC1CA,EAAK,QAAcA,EAAK,MAAM,MAAM,GAAG,CAAC,CAAC,KACtC,MAAMR,EAAM,MALD;EAMpB,CAAC,GAEKU,IAAYH,QACV,CAACP,EAAM,gBAAgB,CAACW,EAAW,SAAS,CAAC,EAAEX,EAAM,uBAAuBA,EAAM,UAC1F,GAEMY,IAAaL,QAAe;GAChC,IAAKG,EAAU,OACf,OAAOV,EAAM,sBAAsBa,EAAc,KAAK,KAAK,gBAAgBA,EAAc,KAAK,KAAK;EACrG,CAAC,GAEKC,UAAgB;GACpB,AAAKJ,EAAU,SAAUV,EAAM,OAC3BA,EAAM,sBACR,OAAO,KAAKe,EAAqBf,EAAM,qBAAqB,EAAE,IAAIA,EAAM,GAAG,CAAC,GAAG,QAAQ,IAGrFA,EAAM,aAAWG,EAAO,KAAK;IAAE,MAAMH,EAAM;IAAW,QAAQ,EAAE,IAAIA,EAAM,GAAG;GAAE,CAAC;EACtF;E,kBAIEnB,EAAA,GAAAC,EAyCM,OAzCNe,GAyCM,CAxCSI,EAAA,KAEAlB,EAAA4B,CAAA,KADb9B,EAAA,GAAAG,EAcQC,GAAA;;GAZN,OAAM;GACN,MAAK;GACJ,eAAagB,EAAA;GACd,WAAQ;;GACT,SAAAf,QACE,CADFC,EAAA,OACEC,EAAGa,EAAA,EAAE,IAAG,KACT,CAAA,GAAAZ,EAKWC,GAAA;IAJT,WAAU;IACV,UAAS;;IAET,SAAAJ,QAAgD,CAA7CC,EAAAC,EAAAL,EAAA2C,CAAA,CAAC,CAAA,uCAAA,CAAA,GAAA,CAAA,C;;;;E,2BAGR7C,EAAA,GAAAG,EAuBQC,GAAA;;GArBN,OAAKM,EAAA,CAAC,QACEmB,EAAA,QAAS,KAAA,eAAA,CAAA;GACjB,MAAK;GACJ,eAAaE,EAAA;GACb,eAAaX,EAAA;GACb,SAAKT,EAAOsB,GAAO,CAAA,MAAA,CAAA;;GAEpB,SAAA5B,QAKE;IAJMH,EAAA8C,CAAA,KADRhD,EAAA,GAAAG,EAKES,GAAA;;KAHC,MAAMV,EAAA0B,CAAA;KACP,mBAAgB;KACf,MAAM;;IACPtB,EAAA,MACFC,EAAGkB,EAAA,KAAI,IAAG,KACV,CAAA;IACSvB,EAAA8C,CAAA,I,aADThD,EAAA,GAAAG,EAMEW,GAAA;;KAJC,MAAM;KACN,OAAO;KACR,eAAA;KACA,OAAM;;;;;;;;E,OArCVd,EAAA,GAAAC,EAAyB,QAAAgB,GAAR,GAAC,E"}
+{"version":3,"file":"ACachedUserChip.vue_vue_type_script_setup_true_lang.js","names":["_openBlock","_createElementBlock","_unref","_createBlock","_component_VChip","_withCtx","_createTextVNode","_toDisplayString","_createVNode","_component_VTooltip","_normalizeClass","_withModifiers","AAnzuUserAvatar","_createCommentVNode","_component_VProgressCircular","AAnzuUserAvatar_default","_hoisted_1","_hoisted_2","ACachedUserChip_vue_vue_type_script_setup_true_lang_default","props","__props","useI18n","router","useRouter","useCachedItem","text","computed","user","cached","clickable","unresolved","appendIcon","COMMON_CONFIG","onClick","replaceUrlParameters","openBlock","createElementBlock","unref","createBlock","VChip","withCtx","createTextVNode","toDisplayString","createVNode","VTooltip","t","normalizeClass","withModifiers","loaded","createCommentVNode","VProgressCircular"],"sources":["../../../../src/domains/cached/components/ACachedUserChip.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport type { IntegerIdNullable } from '@/shared/types/common'\nimport { computed } from 'vue'\nimport { useI18n } from 'vue-i18n'\nimport { useRouter } from 'vue-router'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport type { CachedItem } from '@/domains/cached/composables/defineCached'\nimport { COMMON_CONFIG } from '@/shared/commonConfig'\nimport AAnzuUserAvatar from '@/domains/ui/components/AAnzuUserAvatar.vue'\nimport { replaceUrlParameters } from '@/domains/api/utils/apiHelper'\nimport { useCachedItem } from '@/domains/cached/composables/useCachedItem'\n\nconst props = withDefaults(\n  defineProps<{\n    id: IntegerIdNullable | undefined\n    /** The admin's cache getter, e.g. `getCachedUser` of its `useCachedUsers()`. */\n    getCachedFn: (id: IntegerIdNullable | undefined) => CachedItem<AnzuUserMinimal> | undefined\n    routeName?: string | undefined\n    externalUrlTemplate?: string | undefined\n    /**\n     * Label for caches whose users carry a better one than `person.fullName`, such as a nickname.\n     * `any` because it reads the admin's own user type, which `AnzuUserMinimal` does not describe.\n     */\n    titleFn?: ((user: CachedItem<any>) => string) | undefined\n    disableClick?: boolean\n    /** Label of the close button when Vuetify defaults make the chip closable. Defaults to \"Remove\". */\n    closeLabel?: string\n  }>(),\n  {\n    routeName: undefined,\n    externalUrlTemplate: undefined,\n    titleFn: undefined,\n    disableClick: false,\n    closeLabel: 'common.button.remove',\n  }\n)\n\nconst { t } = useI18n()\nconst router = useRouter()\n// 0 counts as no id, as in `defineCached`. A blank factory record carries it.\nconst { cached, loaded, unresolved } = useCachedItem(() => (props.id ? props.getCachedFn(props.id) : undefined))\n\n// Optional chaining on purpose. Each admin maps its own users into the cache.\n// A mapper that omits the name or e-mail falls through to the next label instead of throwing.\nconst text = computed(() => {\n  const user = cached.value\n  if (!user) return ''\n  const title = props.titleFn ? props.titleFn(user) : ''\n  if (title) return title\n  if (user.person?.fullName) return user.person.fullName\n  if (user.email) return user.email.split('@')[0]\n  return '#' + props.id\n})\n\nconst clickable = computed(\n  () => !props.disableClick && !unresolved.value && !!(props.externalUrlTemplate || props.routeName)\n)\n\nconst appendIcon = computed(() => {\n  if (!clickable.value) return undefined\n  return props.externalUrlTemplate ? COMMON_CONFIG.CHIP.ICON.LINK_EXTERNAL : COMMON_CONFIG.CHIP.ICON.LINK\n})\n\nconst onClick = () => {\n  if (!clickable.value || !props.id) return\n  if (props.externalUrlTemplate) {\n    window.open(replaceUrlParameters(props.externalUrlTemplate, { id: props.id }), '_blank')\n    return\n  }\n  if (props.routeName) router.push({ name: props.routeName, params: { id: props.id } })\n}\n</script>\n\n<template>\n  <div class=\"d-inline-flex\">\n    <span v-if=\"!id\">-</span>\n    <VChip\n      v-else-if=\"unresolved\"\n      class=\"non-clickable\"\n      size=\"small\"\n      :close-label=\"closeLabel\"\n      data-cy=\"cached-user-chip-unresolved\"\n    >\n      #{{ id }}\n      <VTooltip\n        activator=\"parent\"\n        location=\"bottom\"\n      >\n        {{ t('common.model.tracking.userUnavailable') }}\n      </VTooltip>\n    </VChip>\n    <VChip\n      v-else\n      class=\"pl-1\"\n      :class=\"clickable ? '' : 'non-clickable'\"\n      size=\"small\"\n      :append-icon=\"appendIcon\"\n      :close-label=\"closeLabel\"\n      @click.stop=\"onClick\"\n    >\n      <AAnzuUserAvatar\n        v-if=\"loaded\"\n        :user=\"cached\"\n        container-class=\"mr-1\"\n        :size=\"20\"\n      />\n      {{ text }}\n      <VProgressCircular\n        v-if=\"!loaded\"\n        :size=\"12\"\n        :width=\"2\"\n        indeterminate\n        class=\"ml-1\"\n      />\n    </VChip>\n  </div>\n</template>\n\n<style lang=\"scss\" scoped>\n.non-clickable {\n  cursor: default;\n}\n</style>\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYA,IAAMmB,IAAQC,GAyBR,EAAE,SAAMC,EAAQ,GAChBC,IAASC,EAAU,GAEnB,EAAE,WAAQ,WAAQ,kBAAeC,QAAqBL,EAAM,KAAKA,EAAM,YAAYA,EAAM,EAAE,IAAI,KAAA,CAAU,GAIzGM,IAAOC,QAAe;GAC1B,IAAMC,IAAOC,EAAO;GAMpB,OALKD,KACSR,EAAM,UAAUA,EAAM,QAAQQ,CAAI,IAAI,QAEhDA,EAAK,QAAQ,WAAiBA,EAAK,OAAO,WAC1CA,EAAK,QAAcA,EAAK,MAAM,MAAM,GAAG,CAAC,CAAC,KACtC,MAAMR,EAAM,MALD;EAMpB,CAAC,GAEKU,IAAYH,QACV,CAACP,EAAM,gBAAgB,CAACW,EAAW,SAAS,CAAC,EAAEX,EAAM,uBAAuBA,EAAM,UAC1F,GAEMY,IAAaL,QAAe;GAChC,IAAKG,EAAU,OACf,OAAOV,EAAM,sBAAsBa,EAAc,KAAK,KAAK,gBAAgBA,EAAc,KAAK,KAAK;EACrG,CAAC,GAEKC,UAAgB;GACpB,AAAKJ,EAAU,SAAUV,EAAM,OAC3BA,EAAM,sBACR,OAAO,KAAKe,EAAqBf,EAAM,qBAAqB,EAAE,IAAIA,EAAM,GAAG,CAAC,GAAG,QAAQ,IAGrFA,EAAM,aAAWG,EAAO,KAAK;IAAE,MAAMH,EAAM;IAAW,QAAQ,EAAE,IAAIA,EAAM,GAAG;GAAE,CAAC;EACtF;E,kBAIEnB,EAAA,GAAAC,EAyCM,OAzCNe,GAyCM,CAxCSI,EAAA,KAEAlB,EAAA4B,CAAA,KADb9B,EAAA,GAAAG,EAcQC,GAAA;;GAZN,OAAM;GACN,MAAK;GACJ,eAAagB,EAAA;GACd,WAAQ;;GACT,SAAAf,QACE,CADFC,EAAA,OACEC,EAAGa,EAAA,EAAE,IAAG,KACT,CAAA,GAAAZ,EAKWC,GAAA;IAJT,WAAU;IACV,UAAS;;IAET,SAAAJ,QAAgD,CAA7CC,EAAAC,EAAAL,EAAA2C,CAAA,CAAC,CAAA,uCAAA,CAAA,GAAA,CAAA,C;;;;E,2BAGR7C,EAAA,GAAAG,EAuBQC,GAAA;;GArBN,OAAKM,EAAA,CAAC,QACEmB,EAAA,QAAS,KAAA,eAAA,CAAA;GACjB,MAAK;GACJ,eAAaE,EAAA;GACb,eAAaX,EAAA;GACb,SAAKT,EAAOsB,GAAO,CAAA,MAAA,CAAA;;GAEpB,SAAA5B,QAKE;IAJMH,EAAA8C,CAAA,KADRhD,EAAA,GAAAG,EAKES,GAAA;;KAHC,MAAMV,EAAA0B,CAAA;KACP,mBAAgB;KACf,MAAM;;IACPtB,EAAA,MACFC,EAAGkB,EAAA,KAAI,IAAG,KACV,CAAA;IACSvB,EAAA8C,CAAA,I,aADThD,EAAA,GAAAG,EAMEW,GAAA;;KAJC,MAAM;KACN,OAAO;KACR,eAAA;KACA,OAAM;;;;;;;;E,OArCVd,EAAA,GAAAC,EAAyB,QAAAgB,GAAR,GAAC,E"}

package/dist/domains/cached/composables/createUserAndTimeTrackingFields.d.ts

@@ -4,16 +4,16 @@ import { CachedItem } from './defineCached';
 import { UserAndTimeTrackingUsers } from '../../../shared/types/UserAndTimeTracking';
 export interface CreateUserAndTimeTrackingFieldsOptions<U extends AnzuUserMinimal = AnzuUserMinimal> {
     /**
-     * The admin's user cache composable, e.g. its `useCachedUsers`. Invoked inside the component's
-     * setup, once, so the cache resolves in component scope.
+     * The admin's user cache composable, e.g. its `useCachedUsers`.
+     * Called once inside the component's setup, so the cache resolves in component scope.
      */
     useCachedUsers: () => UserAndTimeTrackingUsers<U>;
     /**
-     * Named route of a user's detail (e.g. `'/(common)/users/[id]'`); without it the chip is no link. A function is read
-     * on each render, so the link can follow the current user's permission for that route.
+     * Named route of a user's detail, e.g. `'/(common)/users/[id]'`. Without it the chip is not a link.
+     * A function is read on each render, so the link can follow the current user's permission for that route.
      */
     userRouteName?: string | (() => string | undefined);
-    /** A user's detail in another admin, `:id` replaced; opens in a new tab. */
+    /** URL of a user's detail in another admin, with `:id` replaced. Opens in a new tab. */
     userExternalUrlTemplate?: string;
     /** The chip's label, for users that carry a better one than `person.fullName`. */
     userTitleFn?: (user: CachedItem<U>) => string;
@@ -21,11 +21,11 @@ export interface CreateUserAndTimeTrackingFieldsOptions<U extends AnzuUserMinima
     name?: string;
 }
 /**
- * Builds an admin's created / modified rows from its user cache and routes, so each admin's
- * `XTrackingFields.vue` is a single factory call over `AUserAndTimeTrackingFields`, as each
- * `CachedXChip.vue` is over `ACachedChip`. `hide-*` and the `user` slot fall through.
+ * Builds an admin's created / modified rows from its user cache and routes.
+ * Each admin's `XTrackingFields.vue` becomes one factory call over
+ * `AUserAndTimeTrackingFields`. `hide-*` props and the `user` slot fall through.
  *
- * Use in an SFC's plain `<script lang="ts">` (not `setup`):
+ * Use in an SFC's plain `<script lang="ts">`, not `setup`:
  * ```ts
  * export default createUserAndTimeTrackingFields({
  *   useCachedUsers,

package/dist/domains/cached/composables/createUserAndTimeTrackingFields.js.map

@@ -1 +1 @@
-{"version":3,"file":"createUserAndTimeTrackingFields.js","names":["AUserAndTimeTrackingFields","AUserAndTimeTrackingFields_default","createUserAndTimeTrackingFields","defineComponent","options","users","h","props","isFunction","attrs","slots"],"sources":["../../../../src/domains/cached/composables/createUserAndTimeTrackingFields.ts"],"sourcesContent":["import { type Component, defineComponent, h, type PropType } from 'vue'\nimport { isFunction } from '@/shared/utils/common'\nimport AUserAndTimeTrackingFields from '@/domains/ui/components/AUserAndTimeTrackingFields.vue'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport type { CachedItem } from '@/domains/cached/composables/defineCached'\nimport type { UserAndTimeTrackingData, UserAndTimeTrackingUsers } from '@/shared/types/UserAndTimeTracking'\n\nexport interface CreateUserAndTimeTrackingFieldsOptions<U extends AnzuUserMinimal = AnzuUserMinimal> {\n  /**\n   * The admin's user cache composable, e.g. its `useCachedUsers`. Invoked inside the component's\n   * setup, once, so the cache resolves in component scope.\n   */\n  useCachedUsers: () => UserAndTimeTrackingUsers<U>\n  /**\n   * Named route of a user's detail (e.g. `'/(common)/users/[id]'`); without it the chip is no link. A function is read\n   * on each render, so the link can follow the current user's permission for that route.\n   */\n  userRouteName?: string | (() => string | undefined)\n  /** A user's detail in another admin, `:id` replaced; opens in a new tab. */\n  userExternalUrlTemplate?: string\n  /** The chip's label, for users that carry a better one than `person.fullName`. */\n  userTitleFn?: (user: CachedItem<U>) => string\n  /** Component name for devtools / warnings. */\n  name?: string\n}\n\n/**\n * Builds an admin's created / modified rows from its user cache and routes, so each admin's\n * `XTrackingFields.vue` is a single factory call over `AUserAndTimeTrackingFields`, as each\n * `CachedXChip.vue` is over `ACachedChip`. `hide-*` and the `user` slot fall through.\n *\n * Use in an SFC's plain `<script lang=\"ts\">` (not `setup`):\n * ```ts\n * export default createUserAndTimeTrackingFields({\n *   useCachedUsers,\n *   userRouteName: '/(common)/users/[id]',\n * })\n * ```\n */\nexport function createUserAndTimeTrackingFields<U extends AnzuUserMinimal = AnzuUserMinimal>(\n  options: CreateUserAndTimeTrackingFieldsOptions<U>\n): Component {\n  return defineComponent({\n    name: options.name ?? 'UserAndTimeTrackingFields',\n    inheritAttrs: false,\n    props: {\n      data: { type: Object as PropType<UserAndTimeTrackingData>, required: true },\n    },\n    setup(props, { attrs, slots }) {\n      const users = options.useCachedUsers()\n      return () =>\n        h(\n          AUserAndTimeTrackingFields,\n          {\n            data: props.data,\n            users,\n            userRouteName: isFunction(options.userRouteName) ? options.userRouteName() : options.userRouteName,\n            userExternalUrlTemplate: options.userExternalUrlTemplate,\n            userTitleFn: options.userTitleFn,\n            ...attrs,\n          },\n          slots\n        )\n    },\n  })\n}\n"],"mappings":";;;;AAuCA,SAAgBE,EACd,GACW;CACX,OAAOC,EAAgB;EACrB,MAAMC,EAAQ,QAAQ;EACtB,cAAc;EACd,OAAO,EACL,MAAM;GAAE,MAAM;GAA6C,UAAU;EAAK,EAC5E;EACA,MAAM,GAAO,EAAE,UAAO,YAAS;GAC7B,IAAMC,IAAQD,EAAQ,eAAe;GACrC,aACEE,EACEN,GACA;IACE,MAAMO,EAAM;IACZ;IACA,eAAeC,EAAWJ,EAAQ,aAAa,IAAIA,EAAQ,cAAc,IAAIA,EAAQ;IACrF,yBAAyBA,EAAQ;IACjC,aAAaA,EAAQ;IACrB,GAAGK;GACL,GACAC,CACF;EACJ;CACF,CAAC;AACH"}
+{"version":3,"file":"createUserAndTimeTrackingFields.js","names":["AUserAndTimeTrackingFields","AUserAndTimeTrackingFields_default","createUserAndTimeTrackingFields","defineComponent","options","users","h","props","isFunction","attrs","slots"],"sources":["../../../../src/domains/cached/composables/createUserAndTimeTrackingFields.ts"],"sourcesContent":["import { type Component, defineComponent, h, type PropType } from 'vue'\nimport { isFunction } from '@/shared/utils/common'\nimport AUserAndTimeTrackingFields from '@/domains/ui/components/AUserAndTimeTrackingFields.vue'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport type { CachedItem } from '@/domains/cached/composables/defineCached'\nimport type { UserAndTimeTrackingData, UserAndTimeTrackingUsers } from '@/shared/types/UserAndTimeTracking'\n\nexport interface CreateUserAndTimeTrackingFieldsOptions<U extends AnzuUserMinimal = AnzuUserMinimal> {\n  /**\n   * The admin's user cache composable, e.g. its `useCachedUsers`.\n   * Called once inside the component's setup, so the cache resolves in component scope.\n   */\n  useCachedUsers: () => UserAndTimeTrackingUsers<U>\n  /**\n   * Named route of a user's detail, e.g. `'/(common)/users/[id]'`. Without it the chip is not a link.\n   * A function is read on each render, so the link can follow the current user's permission for that route.\n   */\n  userRouteName?: string | (() => string | undefined)\n  /** URL of a user's detail in another admin, with `:id` replaced. Opens in a new tab. */\n  userExternalUrlTemplate?: string\n  /** The chip's label, for users that carry a better one than `person.fullName`. */\n  userTitleFn?: (user: CachedItem<U>) => string\n  /** Component name for devtools / warnings. */\n  name?: string\n}\n\n/**\n * Builds an admin's created / modified rows from its user cache and routes.\n * Each admin's `XTrackingFields.vue` becomes one factory call over\n * `AUserAndTimeTrackingFields`. `hide-*` props and the `user` slot fall through.\n *\n * Use in an SFC's plain `<script lang=\"ts\">`, not `setup`:\n * ```ts\n * export default createUserAndTimeTrackingFields({\n *   useCachedUsers,\n *   userRouteName: '/(common)/users/[id]',\n * })\n * ```\n */\nexport function createUserAndTimeTrackingFields<U extends AnzuUserMinimal = AnzuUserMinimal>(\n  options: CreateUserAndTimeTrackingFieldsOptions<U>\n): Component {\n  return defineComponent({\n    name: options.name ?? 'UserAndTimeTrackingFields',\n    inheritAttrs: false,\n    props: {\n      data: { type: Object as PropType<UserAndTimeTrackingData>, required: true },\n    },\n    setup(props, { attrs, slots }) {\n      const users = options.useCachedUsers()\n      return () =>\n        h(\n          AUserAndTimeTrackingFields,\n          {\n            data: props.data,\n            users,\n            userRouteName: isFunction(options.userRouteName) ? options.userRouteName() : options.userRouteName,\n            userExternalUrlTemplate: options.userExternalUrlTemplate,\n            userTitleFn: options.userTitleFn,\n            ...attrs,\n          },\n          slots\n        )\n    },\n  })\n}\n"],"mappings":";;;;AAuCA,SAAgBE,EACd,GACW;CACX,OAAOC,EAAgB;EACrB,MAAMC,EAAQ,QAAQ;EACtB,cAAc;EACd,OAAO,EACL,MAAM;GAAE,MAAM;GAA6C,UAAU;EAAK,EAC5E;EACA,MAAM,GAAO,EAAE,UAAO,YAAS;GAC7B,IAAMC,IAAQD,EAAQ,eAAe;GACrC,aACEE,EACEN,GACA;IACE,MAAMO,EAAM;IACZ;IACA,eAAeC,EAAWJ,EAAQ,aAAa,IAAIA,EAAQ,cAAc,IAAIA,EAAQ;IACrF,yBAAyBA,EAAQ;IACjC,aAAaA,EAAQ;IACrB,GAAGK;GACL,GACAC,CACF;EACJ;CACF,CAAC;AACH"}

package/dist/domains/cached/composables/defineCached.d.ts

@@ -2,14 +2,14 @@ import { Ref } from 'vue';
 import { DocId, IntegerId } from '../../../shared/types/common';
 /**
  * Why a fetch settled without resolving an item:
- * - `notFound` -- the server answered and the item was not among the results,
- * - `forbidden` -- the user may not read it (403); asking again in this session cannot change that,
- * - `error` -- anything else: the network, a timeout, a 5xx, a 401 before the session is renewed, and a
- *   404 of the whole request, which is a route or a proxy answering rather than an item missing.
+ * - `notFound`: the server answered and the item was not among the results.
+ * - `forbidden`: the user may not read it (403). Asking again in this session cannot change that.
+ * - `error`: anything else. Network, timeout, 5xx, a 401 before session renewal,
+ * or a 404 of the whole request (a route or proxy answering, not a missing item).
  */
 export type CachedUnresolvedReason = 'notFound' | 'forbidden' | 'error';
 /**
- * `_unresolved`: the fetch settled without resolving the item, `_unresolvedReason` says why.
+ * `_unresolved`: the fetch settled without resolving the item. `_unresolvedReason` says why.
  * Whether a later `add()` asks again depends on the reason (see `defineCached`).
  */
 export type CachedItem<T extends object> = T & {
@@ -19,15 +19,17 @@ export type CachedItem<T extends object> = T & {
 };
 export interface DefineCachedOptions {
     /**
-     * Ask again, on the next `add()`, for an id the server did not return. Defaults to `true`: an entity
-     * can be created after the first lookup. A cache of users passes `false` -- an id missing from the
-     * table (a system user of another backend) would otherwise be asked for on every page showing it.
+     * Ask again on the next `add()` for an id the server did not return. Defaults
+     * to `true`, because an entity can be created after the first lookup.
+     * A user cache passes `false`. Otherwise an id missing from the table (a
+     * system user of another backend) is requested on every page that shows it.
      */
     retryNotFound?: boolean;
     /**
-     * How many ids one call of `fetchCallback` gets, each call committed on its own. Defaults to
-     * `FETCH_BY_IDS_BATCH_SIZE`. A backend that takes fewer ids a request needs its own limit here: split
-     * inside the callback, a failing part would take the parts already loaded with it.
+     * How many ids one `fetchCallback` call gets. Each call is
+     * committed on its own. Defaults to `FETCH_BY_IDS_BATCH_SIZE`.
+     * A backend with a lower per-request limit sets it here. Splitting inside
+     * the callback would make one failing part discard the parts already loaded.
      */
     batchSize?: number;
 }

package/dist/domains/cached/composables/defineCached.js.map

@@ -1 +1 @@
-{"version":3,"file":"defineCached.js","names":["isForbidden","isAnzuApiForbiddenError","error","apiErrorStatus","unresolvedReason","isQuiet","isInCauseChain","cause","AnzuApiCancelledError","SessionExpiredError","AuthUnavailableError","defineCached","options","batchSize","cache","ref","toFetch","pinned","inFlight","useSentry","isCached","item","id","isUndefined","retryNotFound","add","args","toAdd","i","arg","isArray","j","prune","mapIdToMinimal","addManual","data","idProp","mapFullToMinimal","addManualMinimal","incoming","protectedIds","overflow","maxLimit","removed","key","value","updateMap","updateToFetch","ids","markUnresolved","reason","fetchBatch","res","fetchCallback","runBatches","items","failures","start","runQueue","run","apiFetch","logFailure","logError","debouncedFetch","useDebounceFn","pending","own","others","other","count"],"sources":["../../../../src/domains/cached/composables/defineCached.ts"],"sourcesContent":["import { type Ref, ref } from 'vue'\nimport { useDebounceFn } from '@vueuse/core'\nimport type { DocId, IntegerId } from '@/shared/types/common'\nimport { isArray, isUndefined } from '@/shared/utils/common'\nimport { useSentry } from '@/domains/system/composables/sentry'\nimport { apiErrorStatus } from '@/domains/api/utils/apiErrors'\nimport { FETCH_BY_IDS_BATCH_SIZE } from '@/domains/api/composables/useApiFetchByIds'\nimport { isAnzuApiForbiddenError } from '@/shared/error/AnzuApiForbiddenError'\nimport { AnzuApiCancelledError } from '@/shared/error/AnzuApiCancelledError'\nimport { SessionExpiredError } from '@/shared/error/SessionExpiredError'\nimport { AuthUnavailableError } from '@/shared/error/AuthUnavailableError'\nimport { isInCauseChain } from '@/shared/error/isInCauseChain'\nimport { HTTP_STATUS_FORBIDDEN, HTTP_STATUS_UNAUTHORIZED } from '@/shared/statusCodes'\n\n/**\n * Why a fetch settled without resolving an item:\n * - `notFound` -- the server answered and the item was not among the results,\n * - `forbidden` -- the user may not read it (403); asking again in this session cannot change that,\n * - `error` -- anything else: the network, a timeout, a 5xx, a 401 before the session is renewed, and a\n *   404 of the whole request, which is a route or a proxy answering rather than an item missing.\n */\nexport type CachedUnresolvedReason = 'notFound' | 'forbidden' | 'error'\n\n/**\n * `_unresolved`: the fetch settled without resolving the item, `_unresolvedReason` says why.\n * Whether a later `add()` asks again depends on the reason (see `defineCached`).\n */\nexport type CachedItem<T extends object> = T & {\n  _loaded: boolean\n  _unresolved?: boolean\n  _unresolvedReason?: CachedUnresolvedReason\n}\n\nexport interface DefineCachedOptions {\n  /**\n   * Ask again, on the next `add()`, for an id the server did not return. Defaults to `true`: an entity\n   * can be created after the first lookup. A cache of users passes `false` -- an id missing from the\n   * table (a system user of another backend) would otherwise be asked for on every page showing it.\n   */\n  retryNotFound?: boolean\n  /**\n   * How many ids one call of `fetchCallback` gets, each call committed on its own. Defaults to\n   * `FETCH_BY_IDS_BATCH_SIZE`. A backend that takes fewer ids a request needs its own limit here: split\n   * inside the callback, a failing part would take the parts already loaded with it.\n   */\n  batchSize?: number\n}\n\n// A rejected 403 arrives mapped as `AnzuApiForbiddenError`, which carries no status of its own.\nconst isForbidden = (error: unknown) =>\n  isAnzuApiForbiddenError(error) || apiErrorStatus(error) === HTTP_STATUS_FORBIDDEN\n\nconst unresolvedReason = (error: unknown): CachedUnresolvedReason => (isForbidden(error) ? 'forbidden' : 'error')\n\n/**\n * Not a failure to write down: the user may not (403), nobody is logged in (401, or a session found\n * gone on the way out), the auth service did not answer, or the request was stopped. The api layer\n * keeps 401, 403 and an expired session out of its log itself, and writes an unavailable auth service\n * down with the request it stopped; for a cache all of them are the session, not the fetch.\n */\nconst isQuiet = (error: unknown) =>\n  isForbidden(error) ||\n  apiErrorStatus(error) === HTTP_STATUS_UNAUTHORIZED ||\n  isInCauseChain(\n    error,\n    (cause) =>\n      cause instanceof AnzuApiCancelledError ||\n      cause instanceof SessionExpiredError ||\n      cause instanceof AuthUnavailableError\n  )\n\nexport type AddToCachedArgs<T extends DocId | IntegerId> =\n  | Array<T | null | undefined>\n  | Array<Array<T | null | undefined> | T | null | undefined>\n\n/**\n * @template I Identifier type\n * @template T Source type\n * @template M Minimal type\n */\nexport function defineCached<\n  I extends DocId | IntegerId,\n  T extends Record<DocId | IntegerId, any>,\n  M extends Record<DocId | IntegerId, any>,\n>(\n  mapFullToMinimal: (source: T) => M,\n  mapIdToMinimal: (id: I) => M,\n  fetchCallback: (ids: I[]) => Promise<T[]>,\n  idProp = 'id',\n  maxLimit = 1000,\n  options: DefineCachedOptions = {}\n) {\n  const { retryNotFound = true } = options\n  const batchSize =\n    options.batchSize && options.batchSize >= 1 ? Math.floor(options.batchSize) : FETCH_BY_IDS_BATCH_SIZE\n  const cache: Ref<Map<I, CachedItem<M>>> = ref(new Map())\n  const toFetch = ref(new Set()) as Ref<Set<I>>\n  // The ids something shows, each with how many show it (`pin`): the cache drops none of them to stay within its\n  // limit, and goes over it while more than that many are shown. Dropped, a name a chip showed turned it into a\n  // spinner till something added the id again.\n  const pinned = new Map<I, number>()\n  // Settles, never rejects: a run that failed still hands over what its earlier batches loaded.\n  const inFlight = new Set<Promise<{ items: T[]; failures: unknown[] }>>()\n  const { logError } = useSentry()\n\n  /**\n   * Unresolved items are never retried from the queue itself, only on the next `add()`, and only\n   * when asking again can help: a failure (`error`) always, a missing item (`notFound`) unless the\n   * cache opted out, a forbidden one never.\n   */\n  const isCached = (id: I) => {\n    const item = cache.value.get(id)\n    if (isUndefined(item)) return false\n    if (item._unresolved !== true) return true\n    if (item._unresolvedReason === 'forbidden') return true\n    if (item._unresolvedReason === 'notFound') return !retryNotFound\n    return false\n  }\n\n  // Falsy, not only null/undefined: `get`, `has` and `isLoaded` treat 0 and '' as no id, and a blank\n  // factory record (`createdBy: 0`) would otherwise be sent to the server as `filter_in[id]=0`.\n  const add = (...args: AddToCachedArgs<I>) => {\n    const toAdd = new Set<I>()\n    for (let i = 0; i < args.length; i++) {\n      const arg = args[i]\n      if (!arg) continue\n      if (isArray(arg)) {\n        for (let j = 0; j < arg.length; j++) {\n          const item = arg[j]\n          if (!item) continue\n          if (!isCached(item)) toAdd.add(item)\n        }\n        continue\n      }\n      if (!isCached(arg)) toAdd.add(arg)\n    }\n    if (toAdd.size === 0) return\n    prune(toAdd)\n    toAdd.forEach((id) => {\n      cache.value.set(id, {\n        ...mapIdToMinimal(id),\n        _loaded: false,\n      })\n      toFetch.value.add(id)\n    })\n  }\n\n  // Out of the queue as well: an id added and then supplied by hand would still be fetched, and the\n  // answer would overwrite what the caller just put in.\n  const addManual = (data: T) => {\n    const id = data[idProp] as I\n    if (!id) return\n    prune(new Set([id]))\n    cache.value.set(id, {\n      ...mapFullToMinimal(data),\n      _loaded: true,\n    })\n    toFetch.value.delete(id)\n  }\n\n  const addManualMinimal = (data: M) => {\n    const id = data[idProp] as I\n    if (!id) return\n    prune(new Set([id]))\n    cache.value.set(id, {\n      ...data,\n      _loaded: true,\n    })\n    toFetch.value.delete(id)\n  }\n\n  /**\n   * Drops only as many oldest terminal entries as the overflow requires; dropping every one\n   * of them would send currently rendered chips back to their loading state. A pinned entry is\n   * never dropped.\n   * Must include `_unresolved`, otherwise repeated failures grow the cache past `maxLimit`.\n   */\n  const prune = (protectedIds?: Set<I>) => {\n    let incoming = 0\n    if (protectedIds) {\n      // Re-queued unresolved ids are already in the cache and do not grow it.\n      for (const id of protectedIds) if (!cache.value.has(id)) incoming += 1\n    }\n    const overflow = cache.value.size + incoming - maxLimit\n    if (overflow <= 0) return\n    let removed = 0\n    for (const [key, value] of cache.value) {\n      if (removed >= overflow) break\n      if (protectedIds?.has(key) || pinned.has(key)) continue\n      if (value._loaded || value._unresolved) {\n        cache.value.delete(key)\n        removed += 1\n      }\n    }\n  }\n\n  const updateMap = (data: T[]) => {\n    prune()\n    for (const item of data) {\n      cache.value.set(item[idProp] as I, {\n        ...mapFullToMinimal(item),\n        _loaded: true,\n      })\n    }\n  }\n\n  const updateToFetch = (ids: Array<I>) => {\n    for (const id of ids) {\n      toFetch.value.delete(id)\n    }\n  }\n\n  const markUnresolved = (ids: Array<I>, reason: CachedUnresolvedReason) => {\n    for (const id of ids) {\n      const item = cache.value.get(id)\n      if (isUndefined(item) || item._loaded) continue\n      cache.value.set(id, { ...item, _unresolved: true, _unresolvedReason: reason })\n    }\n  }\n\n  const fetchBatch = async (ids: I[]): Promise<T[]> => {\n    try {\n      // Awaited inside the `try`: a callback that throws before it returns a promise (a dam client\n      // that is not configured) has to settle its ids too, or they would spin for good.\n      const res = await fetchCallback(ids)\n      updateMap(res)\n      markUnresolved(ids, 'notFound')\n      // Back within the limit once the batch is settled: the ids added and still on their way could not be dropped\n      // till then, and a large add left the cache over its limit for good, also when the batch failed.\n      prune()\n      return res\n    } catch (error: unknown) {\n      markUnresolved(ids, unresolvedReason(error))\n      prune()\n      throw error\n    }\n  }\n\n  // In the batches the api helpers would split the request into anyway, one after another, each\n  // committed on its own: a failing batch leaves the ones before it loaded instead of taking them along.\n  const runBatches = async (ids: I[]) => {\n    const items: T[] = []\n    const failures: unknown[] = []\n    for (let start = 0; start < ids.length; start += batchSize) {\n      try {\n        items.push(...(await fetchBatch(ids.slice(start, start + batchSize))))\n      } catch (error: unknown) {\n        failures.push(error)\n      }\n    }\n    return { items, failures }\n  }\n\n  /** Fetches the queue; settles with what loaded and every batch's failure, never rejects. */\n  const runQueue = async () => {\n    if (toFetch.value.size === 0) return { items: [] as T[], failures: [] as unknown[] }\n    const ids = Array.from(toFetch.value)\n    // Drained before the request, not after it. A batch that starts while this one is in flight --\n    // a slow answer outlasting the debounce, the `maxWait` timer, an `immediateFetch()` -- would\n    // otherwise send the same ids again. Draining at all keeps a failing batch from being resent.\n    updateToFetch(ids)\n    const run = runBatches(ids)\n    inFlight.add(run)\n    try {\n      return await run\n    } finally {\n      inFlight.delete(run)\n    }\n  }\n\n  async function apiFetch() {\n    const { items, failures } = await runQueue()\n    if (failures.length > 0) throw failures[0]\n    return items\n  }\n\n  const logFailure = (error: unknown) => {\n    if (isQuiet(error)) return\n    logError(error instanceof Error ? error : new Error(String(error)), {\n      level: 'warning',\n      tags: { cachedFetch: 'failed' },\n    })\n  }\n\n  // Caught inside the debounced callback, not on the promise it returns: the maxWait timer\n  // is a second invocation path whose promise never reaches the caller, so a rejection\n  // there would escape as an unhandled rejection.\n  const debouncedFetch = useDebounceFn(\n    async () => {\n      try {\n        // Every batch's failure, not only the first: a 403 in one would otherwise hide a timeout in\n        // the next.\n        const { items, failures } = await runQueue()\n        failures.forEach(logFailure)\n        return items\n      } catch (error: unknown) {\n        logFailure(error)\n        return [] as T[]\n      }\n    },\n    1500,\n    { maxWait: 5000 }\n  )\n\n  /**\n   * Debounced fetch for best performance.\n   * For general usage.\n   *\n   * Called fire-and-forget, so it never rejects. Use `immediateFetch()` to handle errors.\n   */\n  const fetch = () => {\n    return debouncedFetch()\n  }\n\n  /**\n   * Immediate fetch with no debounce and with result in promise.\n   * Use for special cases.\n   *\n   * Waits for the batches already in flight as well and resolves with their items: their ids are out\n   * of the queue, and a caller reading the result (to add the relations of what it fetched) would miss\n   * them. It rejects only when its own batch fails; an id whose batch in flight failed is not in the\n   * result -- check `isUnresolved(id)` for it.\n   */\n  const immediateFetch = async () => {\n    const pending = Array.from(inFlight)\n    const own = await apiFetch()\n    const others = await Promise.all(pending)\n    return [...own, ...others.flatMap((other) => other.items)]\n  }\n\n  /** Something shows the item of `id`: the cache keeps it till as many `unpin` have come. */\n  const pin = (id: I | null | undefined) => {\n    if (!id) return\n    pinned.set(id, (pinned.get(id) ?? 0) + 1)\n  }\n\n  /** What showed the item of `id` no longer does. The cache goes back within its limit once none is left. */\n  const unpin = (id: I | null | undefined) => {\n    if (!id) return\n    const count = pinned.get(id)\n    if (isUndefined(count)) return\n    if (count > 1) {\n      pinned.set(id, count - 1)\n      return\n    }\n    pinned.delete(id)\n    prune()\n  }\n\n  const get = (id: I | null | undefined) => {\n    if (!id) return undefined\n    return cache.value.get(id)\n  }\n\n  const has = (id: I | null | undefined): boolean => {\n    if (!id) return false\n    return cache.value.has(id)\n  }\n\n  const clear = () => {\n    return cache.value.clear()\n  }\n\n  const isLoaded = (id: I | null | undefined): boolean => {\n    if (!id) return false\n    const item = cache.value.get(id)\n    if (!item) return false\n    return item._loaded\n  }\n\n  /** Terminal counterpart of `isLoaded`: the fetch settled without resolving the item. */\n  const isUnresolved = (id: I | null | undefined): boolean => {\n    if (!id) return false\n    return cache.value.get(id)?._unresolved === true\n  }\n\n  return {\n    cache,\n    toFetch,\n    fetch,\n    immediateFetch,\n    add,\n    addManual,\n    addManualMinimal,\n    pin,\n    unpin,\n    has,\n    get,\n    clear,\n    isLoaded,\n    isUnresolved,\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAiDA,IAAMA,KAAe,MACnBC,EAAwBC,CAAK,KAAKC,EAAeD,CAAK,MAAA,KAElDE,KAAoB,MAA4CJ,EAAYE,CAAK,IAAI,cAAc,SAQnGG,KAAW,MACfL,EAAYE,CAAK,KACjBC,EAAeD,CAAK,MAAA,OACpBI,EACEJ,IACC,MACCK,aAAiBC,KACjBD,aAAiBE,KACjBF,aAAiBG,CACrB;AAWF,SAAgBC,EAKd,GACA,GACA,GACA,IAAS,MACT,IAAW,KACX,IAA+B,CAAC,GAChC;CACA,IAAM,EAAE,mBAAgB,OAASC,GAC3BC,IACJD,EAAQ,aAAaA,EAAQ,aAAa,IAAI,KAAK,MAAMA,EAAQ,SAAS,IAAA,KACtEE,IAAoCC,kBAAI,IAAI,IAAI,CAAC,GACjDC,IAAUD,kBAAI,IAAI,IAAI,CAAC,GAIvBE,oBAAS,IAAI,IAAe,GAE5BC,oBAAW,IAAI,IAAkD,GACjE,EAAE,gBAAaC,EAAU,GAOzBC,KAAY,MAAU;EAC1B,IAAMC,IAAOP,EAAM,MAAM,IAAIQ,CAAE;EAK/B,OAJIC,EAAYF,CAAI,IAAU,KAC1BA,EAAK,gBAAgB,MACrBA,EAAK,sBAAsB,eAC3BA,EAAK,sBAAsB,cAAmB,CAACG;CAErD,GAIMC,KAAO,GAAGC,MAA6B;EAC3C,IAAMC,oBAAQ,IAAI,IAAO;EACzB,KAAK,IAAIC,IAAI,GAAGA,IAAIF,EAAK,QAAQ,KAAK;GACpC,IAAMG,IAAMH,EAAKE;GACjB,IAAKC,GACL;QAAIC,EAAQD,CAAG,GACb,KAAK,IAAIE,IAAI,GAAGA,IAAIF,EAAI,QAAQ,KAAK;KACnC,IAAMR,IAAOQ,EAAIE;KACjB,AAAKV,MACAD,EAASC,CAAI,KAAGM,EAAM,IAAIN,CAAI;IACrC;SAGF,AAAKD,EAASS,CAAG,KAAGF,EAAM,IAAIE,CAAG;GADjC;EAEF;EACA,AAAIF,EAAM,SAAS,MACnBK,EAAML,CAAK,GACXA,EAAM,SAAS,MAAO;GAKpB,AAJAb,EAAM,MAAM,IAAIQ,GAAI;IAClB,GAAGW,EAAeX,CAAE;IACpB,SAAS;GACX,CAAC,GACDN,EAAQ,MAAM,IAAIM,CAAE;EACtB,CAAC;CACH,GAIMY,KAAa,MAAY;EAC7B,IAAMZ,IAAKa,EAAKC;EAChB,AAAKd,MACLU,kBAAM,IAAI,IAAI,CAACV,CAAE,CAAC,CAAC,GACnBR,EAAM,MAAM,IAAIQ,GAAI;GAClB,GAAGe,EAAiBF,CAAI;GACxB,SAAS;EACX,CAAC,GACDnB,EAAQ,MAAM,OAAOM,CAAE;CACzB,GAEMgB,KAAoB,MAAY;EACpC,IAAMhB,IAAKa,EAAKC;EAChB,AAAKd,MACLU,kBAAM,IAAI,IAAI,CAACV,CAAE,CAAC,CAAC,GACnBR,EAAM,MAAM,IAAIQ,GAAI;GAClB,GAAGa;GACH,SAAS;EACX,CAAC,GACDnB,EAAQ,MAAM,OAAOM,CAAE;CACzB,GAQMU,KAAS,MAA0B;EACvC,IAAIO,IAAW;EACf,IAAIC,GAEG,KAAA,IAAMlB,KAAMkB,GAAc,AAAK1B,EAAM,MAAM,IAAIQ,CAAE,MAAG,KAAY;EAEvE,IAAMmB,IAAW3B,EAAM,MAAM,OAAOyB,IAAWG;EAC/C,IAAID,KAAY,GAAG;EACnB,IAAIE,IAAU;EACd,KAAK,IAAM,CAACC,GAAKC,MAAU/B,EAAM,OAAO;GACtC,IAAI6B,KAAWF,GAAU;GACzB,AAAID,GAAc,IAAII,CAAG,KAAK3B,EAAO,IAAI2B,CAAG,MACxCC,EAAM,WAAWA,EAAM,iBACzB/B,EAAM,MAAM,OAAO8B,CAAG,GACtB,KAAW;EAEf;CACF,GAEME,KAAa,MAAc;EAC/B,EAAM;EACN,KAAK,IAAMzB,KAAQc,GACjB,EAAM,MAAM,IAAId,EAAKe,IAAc;GACjC,GAAGC,EAAiBhB,CAAI;GACxB,SAAS;EACX,CAAC;CAEL,GAEM0B,KAAiB,MAAkB;EACvC,KAAK,IAAMzB,KAAM0B,GACf,EAAQ,MAAM,OAAO1B,CAAE;CAE3B,GAEM2B,KAAkB,GAAe,MAAmC;EACxE,KAAK,IAAM3B,KAAM0B,GAAK;GACpB,IAAM3B,IAAOP,EAAM,MAAM,IAAIQ,CAAE;GAC/B,AAAIC,EAAYF,CAAI,KAAKA,EAAK,WAC9BP,EAAM,MAAM,IAAIQ,GAAI;IAAE,GAAGD;IAAM,aAAa;IAAM,mBAAmB6B;GAAO,CAAC;EAC/E;CACF,GAEMC,IAAa,OAAO,MAA2B;EACnD,IAAI;GAGF,IAAMC,IAAM,MAAMC,EAAcL,CAAG;GAMnC,OALAF,EAAUM,CAAG,GACbH,EAAeD,GAAK,UAAU,GAG9BhB,EAAM,GACCoB;EACT,SAASlD,GAAgB;GAGvB,MAFA+C,EAAeD,GAAK5C,EAAiBF,CAAK,CAAC,GAC3C8B,EAAM,GACA9B;EACR;CACF,GAIMoD,IAAa,OAAO,MAAa;EACrC,IAAMC,IAAa,CAAC,GACdC,IAAsB,CAAC;EAC7B,KAAK,IAAIC,IAAQ,GAAGA,IAAQT,EAAI,QAAQ,KAASnC,GAC/C,IAAI;GACF,EAAM,KAAK,GAAI,MAAMsC,EAAWH,EAAI,MAAMS,GAAOA,IAAQ5C,CAAS,CAAC,CAAE;EACvE,SAASX,GAAgB;GACvB,EAAS,KAAKA,CAAK;EACrB;EAEF,OAAO;GAAE;GAAO;EAAS;CAC3B,GAGMwD,IAAW,YAAY;EAC3B,IAAI1C,EAAQ,MAAM,SAAS,GAAG,OAAO;GAAE,OAAO,CAAC;GAAU,UAAU,CAAC;EAAe;EACnF,IAAMgC,IAAM,MAAM,KAAKhC,EAAQ,KAAK;EAIpC,EAAcgC,CAAG;EACjB,IAAMW,IAAML,EAAWN,CAAG;EAC1B,EAAS,IAAIW,CAAG;EAChB,IAAI;GACF,OAAO,MAAMA;EACf,UAAU;GACR,EAAS,OAAOA,CAAG;EACrB;CACF;CAEA,eAAeC,IAAW;EACxB,IAAM,EAAE,UAAO,gBAAa,MAAMF,EAAS;EAC3C,IAAIF,EAAS,SAAS,GAAG,MAAMA,EAAS;EACxC,OAAOD;CACT;CAEA,IAAMM,KAAc,MAAmB;EACrC,AAAIxD,EAAQH,CAAK,KACjB4D,EAAS5D,aAAiB,QAAQA,IAAY,MAAM,OAAOA,CAAK,CAAC,GAAG;GAClE,OAAO;GACP,MAAM,EAAE,aAAa,SAAS;EAChC,CAAC;CACH,GAKM6D,IAAiBC,EACrB,YAAY;EACV,IAAI;GAGF,IAAM,EAAE,UAAO,gBAAa,MAAMN,EAAS;GAE3C,OADAF,EAAS,QAAQK,CAAU,GACpBN;EACT,SAASrD,GAAgB;GAEvB,OADA2D,EAAW3D,CAAK,GACT,CAAC;EACV;CACF,GACA,MACA,EAAE,SAAS,IAAK,CAClB;CA0EA,OAAO;EACL;EACA;EACA,aApEO6D,EAAe;EAqEtB,4BAzDiC;GACjC,IAAME,IAAU,MAAM,KAAK/C,CAAQ,GAC7BgD,IAAM,MAAMN,EAAS,GACrBO,IAAS,MAAM,QAAQ,IAAIF,CAAO;GACxC,OAAO,CAAC,GAAGC,GAAK,GAAGC,EAAO,SAAS,MAAUC,EAAM,KAAK,CAAC;EAC3D;EAqDE;EACA;EACA;EACA,MArDW,MAA6B;GACxC,AAAK9C,KACLL,EAAO,IAAIK,IAAKL,EAAO,IAAIK,CAAE,KAAK,KAAK,CAAC;EAC1C;EAmDE,QAhDa,MAA6B;GAC1C,IAAI,CAACA,GAAI;GACT,IAAM+C,IAAQpD,EAAO,IAAIK,CAAE;GAC3B,AAAIC,EAAY8C,CAAK,MACjBA,IAAQ,IACVpD,EAAO,IAAIK,GAAI+C,IAAQ,CAAC,KAG1BpD,EAAO,OAAOK,CAAE,GAChBU,EAAM;EACR;EAuCE,MAhCW,MACNV,IACER,EAAM,MAAM,IAAIQ,CAAE,IADT;EAgChB,MAtCW,MAA6B;GACxC,IAAKA,GACL,OAAOR,EAAM,MAAM,IAAIQ,CAAE;EAC3B;EAoCE,aA5BOR,EAAM,MAAM,MAAM;EA6BzB,WA1BgB,MAAsC;GACtD,IAAI,CAACQ,GAAI,OAAO;GAChB,IAAMD,IAAOP,EAAM,MAAM,IAAIQ,CAAE;GAE/B,OADKD,IACEA,EAAK,UADM;EAEpB;EAsBE,eAnBoB,MACfC,IACER,EAAM,MAAM,IAAIQ,CAAE,CAAC,EAAE,gBAAgB,KAD5B;CAmBlB;AACF"}
+{"version":3,"file":"defineCached.js","names":["isForbidden","isAnzuApiForbiddenError","error","apiErrorStatus","unresolvedReason","isQuiet","isInCauseChain","cause","AnzuApiCancelledError","SessionExpiredError","AuthUnavailableError","defineCached","options","batchSize","cache","ref","toFetch","pinned","inFlight","useSentry","isCached","item","id","isUndefined","retryNotFound","add","args","toAdd","i","arg","isArray","j","prune","mapIdToMinimal","addManual","data","idProp","mapFullToMinimal","addManualMinimal","incoming","protectedIds","overflow","maxLimit","removed","key","value","updateMap","updateToFetch","ids","markUnresolved","reason","fetchBatch","res","fetchCallback","runBatches","items","failures","start","runQueue","run","apiFetch","logFailure","logError","debouncedFetch","useDebounceFn","pending","own","others","other","count"],"sources":["../../../../src/domains/cached/composables/defineCached.ts"],"sourcesContent":["import { type Ref, ref } from 'vue'\nimport { useDebounceFn } from '@vueuse/core'\nimport type { DocId, IntegerId } from '@/shared/types/common'\nimport { isArray, isUndefined } from '@/shared/utils/common'\nimport { useSentry } from '@/domains/system/composables/sentry'\nimport { apiErrorStatus } from '@/domains/api/utils/apiErrors'\nimport { FETCH_BY_IDS_BATCH_SIZE } from '@/domains/api/composables/useApiFetchByIds'\nimport { isAnzuApiForbiddenError } from '@/shared/error/AnzuApiForbiddenError'\nimport { AnzuApiCancelledError } from '@/shared/error/AnzuApiCancelledError'\nimport { SessionExpiredError } from '@/shared/error/SessionExpiredError'\nimport { AuthUnavailableError } from '@/shared/error/AuthUnavailableError'\nimport { isInCauseChain } from '@/shared/error/isInCauseChain'\nimport { HTTP_STATUS_FORBIDDEN, HTTP_STATUS_UNAUTHORIZED } from '@/shared/statusCodes'\n\n/**\n * Why a fetch settled without resolving an item:\n * - `notFound`: the server answered and the item was not among the results.\n * - `forbidden`: the user may not read it (403). Asking again in this session cannot change that.\n * - `error`: anything else. Network, timeout, 5xx, a 401 before session renewal,\n * or a 404 of the whole request (a route or proxy answering, not a missing item).\n */\nexport type CachedUnresolvedReason = 'notFound' | 'forbidden' | 'error'\n\n/**\n * `_unresolved`: the fetch settled without resolving the item. `_unresolvedReason` says why.\n * Whether a later `add()` asks again depends on the reason (see `defineCached`).\n */\nexport type CachedItem<T extends object> = T & {\n  _loaded: boolean\n  _unresolved?: boolean\n  _unresolvedReason?: CachedUnresolvedReason\n}\n\nexport interface DefineCachedOptions {\n  /**\n   * Ask again on the next `add()` for an id the server did not return. Defaults\n   * to `true`, because an entity can be created after the first lookup.\n   * A user cache passes `false`. Otherwise an id missing from the table (a\n   * system user of another backend) is requested on every page that shows it.\n   */\n  retryNotFound?: boolean\n  /**\n   * How many ids one `fetchCallback` call gets. Each call is\n   * committed on its own. Defaults to `FETCH_BY_IDS_BATCH_SIZE`.\n   * A backend with a lower per-request limit sets it here. Splitting inside\n   * the callback would make one failing part discard the parts already loaded.\n   */\n  batchSize?: number\n}\n\n// A rejected 403 arrives mapped as `AnzuApiForbiddenError`, which carries no status of its own.\nconst isForbidden = (error: unknown) =>\n  isAnzuApiForbiddenError(error) || apiErrorStatus(error) === HTTP_STATUS_FORBIDDEN\n\nconst unresolvedReason = (error: unknown): CachedUnresolvedReason => (isForbidden(error) ? 'forbidden' : 'error')\n\n/**\n * Errors not worth logging: 403, no logged-in user (401 or a\n * session gone), auth service not answering, or an aborted request.\n * The api layer already handles logging of these. For a cache they concern the session, not the fetch.\n */\nconst isQuiet = (error: unknown) =>\n  isForbidden(error) ||\n  apiErrorStatus(error) === HTTP_STATUS_UNAUTHORIZED ||\n  isInCauseChain(\n    error,\n    (cause) =>\n      cause instanceof AnzuApiCancelledError ||\n      cause instanceof SessionExpiredError ||\n      cause instanceof AuthUnavailableError\n  )\n\nexport type AddToCachedArgs<T extends DocId | IntegerId> =\n  | Array<T | null | undefined>\n  | Array<Array<T | null | undefined> | T | null | undefined>\n\n/**\n * @template I Identifier type\n * @template T Source type\n * @template M Minimal type\n */\nexport function defineCached<\n  I extends DocId | IntegerId,\n  T extends Record<DocId | IntegerId, any>,\n  M extends Record<DocId | IntegerId, any>,\n>(\n  mapFullToMinimal: (source: T) => M,\n  mapIdToMinimal: (id: I) => M,\n  fetchCallback: (ids: I[]) => Promise<T[]>,\n  idProp = 'id',\n  maxLimit = 1000,\n  options: DefineCachedOptions = {}\n) {\n  const { retryNotFound = true } = options\n  const batchSize =\n    options.batchSize && options.batchSize >= 1 ? Math.floor(options.batchSize) : FETCH_BY_IDS_BATCH_SIZE\n  const cache: Ref<Map<I, CachedItem<M>>> = ref(new Map())\n  const toFetch = ref(new Set()) as Ref<Set<I>>\n  // Ids currently shown, each with its show count (`pin`). The cache\n  // never drops them to stay within its limit and may exceed it.\n  // Dropping one turned a chip's name back into a spinner until the id was added again.\n  const pinned = new Map<I, number>()\n  // Settles, never rejects. A failed run still hands over what its earlier batches loaded.\n  const inFlight = new Set<Promise<{ items: T[]; failures: unknown[] }>>()\n  const { logError } = useSentry()\n\n  /**\n   * Unresolved items are never retried from the queue, only on the next `add()`, and only when retrying can help.\n   * `error` always retries, `notFound` unless the cache opted out, `forbidden` never.\n   */\n  const isCached = (id: I) => {\n    const item = cache.value.get(id)\n    if (isUndefined(item)) return false\n    if (item._unresolved !== true) return true\n    if (item._unresolvedReason === 'forbidden') return true\n    if (item._unresolvedReason === 'notFound') return !retryNotFound\n    return false\n  }\n\n  // Falsy, not only null/undefined. `get`, `has` and `isLoaded` treat 0 and '' as no id.\n  // Otherwise a blank factory record (`createdBy: 0`) is sent to the server as `filter_in[id]=0`.\n  const add = (...args: AddToCachedArgs<I>) => {\n    const toAdd = new Set<I>()\n    for (let i = 0; i < args.length; i++) {\n      const arg = args[i]\n      if (!arg) continue\n      if (isArray(arg)) {\n        for (let j = 0; j < arg.length; j++) {\n          const item = arg[j]\n          if (!item) continue\n          if (!isCached(item)) toAdd.add(item)\n        }\n        continue\n      }\n      if (!isCached(arg)) toAdd.add(arg)\n    }\n    if (toAdd.size === 0) return\n    prune(toAdd)\n    toAdd.forEach((id) => {\n      cache.value.set(id, {\n        ...mapIdToMinimal(id),\n        _loaded: false,\n      })\n      toFetch.value.add(id)\n    })\n  }\n\n  // Remove it from the queue too. Otherwise a queued id supplied by\n  // hand is still fetched, and the answer overwrites the caller's data.\n  const addManual = (data: T) => {\n    const id = data[idProp] as I\n    if (!id) return\n    prune(new Set([id]))\n    cache.value.set(id, {\n      ...mapFullToMinimal(data),\n      _loaded: true,\n    })\n    toFetch.value.delete(id)\n  }\n\n  const addManualMinimal = (data: M) => {\n    const id = data[idProp] as I\n    if (!id) return\n    prune(new Set([id]))\n    cache.value.set(id, {\n      ...data,\n      _loaded: true,\n    })\n    toFetch.value.delete(id)\n  }\n\n  /**\n   * Drops only as many oldest terminal entries as the overflow\n   * requires. Dropping all would send rendered chips back to loading.\n   * Pinned entries are never dropped.\n   * Must include `_unresolved` entries, otherwise repeated failures grow the cache past `maxLimit`.\n   */\n  const prune = (protectedIds?: Set<I>) => {\n    let incoming = 0\n    if (protectedIds) {\n      // Re-queued unresolved ids are already in the cache and do not grow it.\n      for (const id of protectedIds) if (!cache.value.has(id)) incoming += 1\n    }\n    const overflow = cache.value.size + incoming - maxLimit\n    if (overflow <= 0) return\n    let removed = 0\n    for (const [key, value] of cache.value) {\n      if (removed >= overflow) break\n      if (protectedIds?.has(key) || pinned.has(key)) continue\n      if (value._loaded || value._unresolved) {\n        cache.value.delete(key)\n        removed += 1\n      }\n    }\n  }\n\n  const updateMap = (data: T[]) => {\n    prune()\n    for (const item of data) {\n      cache.value.set(item[idProp] as I, {\n        ...mapFullToMinimal(item),\n        _loaded: true,\n      })\n    }\n  }\n\n  const updateToFetch = (ids: Array<I>) => {\n    for (const id of ids) {\n      toFetch.value.delete(id)\n    }\n  }\n\n  const markUnresolved = (ids: Array<I>, reason: CachedUnresolvedReason) => {\n    for (const id of ids) {\n      const item = cache.value.get(id)\n      if (isUndefined(item) || item._loaded) continue\n      cache.value.set(id, { ...item, _unresolved: true, _unresolvedReason: reason })\n    }\n  }\n\n  const fetchBatch = async (ids: I[]): Promise<T[]> => {\n    try {\n      // Awaited inside the `try`. A callback that throws before returning a promise\n      // (e.g. an unconfigured dam client) must settle its ids too, or they spin forever.\n      const res = await fetchCallback(ids)\n      updateMap(res)\n      markUnresolved(ids, 'notFound')\n      // Prune once the batch settles. Ids in flight cannot be dropped before that.\n      // Without this, a large add left the cache over its limit for good, also when the batch failed.\n      prune()\n      return res\n    } catch (error: unknown) {\n      markUnresolved(ids, unresolvedReason(error))\n      prune()\n      throw error\n    }\n  }\n\n  // Fetches in the same batches the api helpers would use, sequentially, each committed on its own.\n  // A failing batch then leaves earlier batches loaded.\n  const runBatches = async (ids: I[]) => {\n    const items: T[] = []\n    const failures: unknown[] = []\n    for (let start = 0; start < ids.length; start += batchSize) {\n      try {\n        items.push(...(await fetchBatch(ids.slice(start, start + batchSize))))\n      } catch (error: unknown) {\n        failures.push(error)\n      }\n    }\n    return { items, failures }\n  }\n\n  /** Fetches the queue; settles with what loaded and every batch's failure, never rejects. */\n  const runQueue = async () => {\n    if (toFetch.value.size === 0) return { items: [] as T[], failures: [] as unknown[] }\n    const ids = Array.from(toFetch.value)\n    // Drained before the request, not after. Otherwise a batch\n    // started while this one is in flight resends the same ids.\n    // That happens with a slow answer outlasting the debounce, the `maxWait` timer, or `immediateFetch()`.\n    // Draining also keeps a failing batch from being resent.\n    updateToFetch(ids)\n    const run = runBatches(ids)\n    inFlight.add(run)\n    try {\n      return await run\n    } finally {\n      inFlight.delete(run)\n    }\n  }\n\n  async function apiFetch() {\n    const { items, failures } = await runQueue()\n    if (failures.length > 0) throw failures[0]\n    return items\n  }\n\n  const logFailure = (error: unknown) => {\n    if (isQuiet(error)) return\n    logError(error instanceof Error ? error : new Error(String(error)), {\n      level: 'warning',\n      tags: { cachedFetch: 'failed' },\n    })\n  }\n\n  // Caught inside the debounced callback, not on its returned promise.\n  // The `maxWait` timer is a second invocation path whose promise\n  // never reaches the caller, so a rejection there would be unhandled.\n  const debouncedFetch = useDebounceFn(\n    async () => {\n      try {\n        // Log every batch's failure, not only the first. A 403 in one would otherwise hide a timeout in the next.\n        const { items, failures } = await runQueue()\n        failures.forEach(logFailure)\n        return items\n      } catch (error: unknown) {\n        logFailure(error)\n        return [] as T[]\n      }\n    },\n    1500,\n    { maxWait: 5000 }\n  )\n\n  /**\n   * Debounced fetch for general use.\n   * Called fire-and-forget, so it never rejects. Use `immediateFetch()` to handle errors.\n   */\n  const fetch = () => {\n    return debouncedFetch()\n  }\n\n  /**\n   * Immediate fetch without debounce, returning the result.\n   * Also waits for batches already in flight and includes their items, since\n   * their ids are out of the queue and callers adding relations would miss them.\n   * Rejects only when its own batch fails. An id whose in-flight batch\n   * failed is missing from the result; check `isUnresolved(id)`.\n   */\n  const immediateFetch = async () => {\n    const pending = Array.from(inFlight)\n    const own = await apiFetch()\n    const others = await Promise.all(pending)\n    return [...own, ...others.flatMap((other) => other.items)]\n  }\n\n  /** Marks the item of `id` as shown. The cache keeps it until a matching number of `unpin` calls. */\n  const pin = (id: I | null | undefined) => {\n    if (!id) return\n    pinned.set(id, (pinned.get(id) ?? 0) + 1)\n  }\n\n  /** Marks the item of `id` as no longer shown. The cache returns within its limit once no pins are left. */\n  const unpin = (id: I | null | undefined) => {\n    if (!id) return\n    const count = pinned.get(id)\n    if (isUndefined(count)) return\n    if (count > 1) {\n      pinned.set(id, count - 1)\n      return\n    }\n    pinned.delete(id)\n    prune()\n  }\n\n  const get = (id: I | null | undefined) => {\n    if (!id) return undefined\n    return cache.value.get(id)\n  }\n\n  const has = (id: I | null | undefined): boolean => {\n    if (!id) return false\n    return cache.value.has(id)\n  }\n\n  const clear = () => {\n    return cache.value.clear()\n  }\n\n  const isLoaded = (id: I | null | undefined): boolean => {\n    if (!id) return false\n    const item = cache.value.get(id)\n    if (!item) return false\n    return item._loaded\n  }\n\n  /** Terminal counterpart of `isLoaded`: the fetch settled without resolving the item. */\n  const isUnresolved = (id: I | null | undefined): boolean => {\n    if (!id) return false\n    return cache.value.get(id)?._unresolved === true\n  }\n\n  return {\n    cache,\n    toFetch,\n    fetch,\n    immediateFetch,\n    add,\n    addManual,\n    addManualMinimal,\n    pin,\n    unpin,\n    has,\n    get,\n    clear,\n    isLoaded,\n    isUnresolved,\n  }\n}\n"],"mappings":";;;;;;;;;;;;AAmDA,IAAMA,KAAe,MACnBC,EAAwBC,CAAK,KAAKC,EAAeD,CAAK,MAAA,KAElDE,KAAoB,MAA4CJ,EAAYE,CAAK,IAAI,cAAc,SAOnGG,KAAW,MACfL,EAAYE,CAAK,KACjBC,EAAeD,CAAK,MAAA,OACpBI,EACEJ,IACC,MACCK,aAAiBC,KACjBD,aAAiBE,KACjBF,aAAiBG,CACrB;AAWF,SAAgBC,EAKd,GACA,GACA,GACA,IAAS,MACT,IAAW,KACX,IAA+B,CAAC,GAChC;CACA,IAAM,EAAE,mBAAgB,OAASC,GAC3BC,IACJD,EAAQ,aAAaA,EAAQ,aAAa,IAAI,KAAK,MAAMA,EAAQ,SAAS,IAAA,KACtEE,IAAoCC,kBAAI,IAAI,IAAI,CAAC,GACjDC,IAAUD,kBAAI,IAAI,IAAI,CAAC,GAIvBE,oBAAS,IAAI,IAAe,GAE5BC,oBAAW,IAAI,IAAkD,GACjE,EAAE,gBAAaC,EAAU,GAMzBC,KAAY,MAAU;EAC1B,IAAMC,IAAOP,EAAM,MAAM,IAAIQ,CAAE;EAK/B,OAJIC,EAAYF,CAAI,IAAU,KAC1BA,EAAK,gBAAgB,MACrBA,EAAK,sBAAsB,eAC3BA,EAAK,sBAAsB,cAAmB,CAACG;CAErD,GAIMC,KAAO,GAAGC,MAA6B;EAC3C,IAAMC,oBAAQ,IAAI,IAAO;EACzB,KAAK,IAAIC,IAAI,GAAGA,IAAIF,EAAK,QAAQ,KAAK;GACpC,IAAMG,IAAMH,EAAKE;GACjB,IAAKC,GACL;QAAIC,EAAQD,CAAG,GACb,KAAK,IAAIE,IAAI,GAAGA,IAAIF,EAAI,QAAQ,KAAK;KACnC,IAAMR,IAAOQ,EAAIE;KACjB,AAAKV,MACAD,EAASC,CAAI,KAAGM,EAAM,IAAIN,CAAI;IACrC;SAGF,AAAKD,EAASS,CAAG,KAAGF,EAAM,IAAIE,CAAG;GADjC;EAEF;EACA,AAAIF,EAAM,SAAS,MACnBK,EAAML,CAAK,GACXA,EAAM,SAAS,MAAO;GAKpB,AAJAb,EAAM,MAAM,IAAIQ,GAAI;IAClB,GAAGW,EAAeX,CAAE;IACpB,SAAS;GACX,CAAC,GACDN,EAAQ,MAAM,IAAIM,CAAE;EACtB,CAAC;CACH,GAIMY,KAAa,MAAY;EAC7B,IAAMZ,IAAKa,EAAKC;EAChB,AAAKd,MACLU,kBAAM,IAAI,IAAI,CAACV,CAAE,CAAC,CAAC,GACnBR,EAAM,MAAM,IAAIQ,GAAI;GAClB,GAAGe,EAAiBF,CAAI;GACxB,SAAS;EACX,CAAC,GACDnB,EAAQ,MAAM,OAAOM,CAAE;CACzB,GAEMgB,KAAoB,MAAY;EACpC,IAAMhB,IAAKa,EAAKC;EAChB,AAAKd,MACLU,kBAAM,IAAI,IAAI,CAACV,CAAE,CAAC,CAAC,GACnBR,EAAM,MAAM,IAAIQ,GAAI;GAClB,GAAGa;GACH,SAAS;EACX,CAAC,GACDnB,EAAQ,MAAM,OAAOM,CAAE;CACzB,GAQMU,KAAS,MAA0B;EACvC,IAAIO,IAAW;EACf,IAAIC,GAEG,KAAA,IAAMlB,KAAMkB,GAAc,AAAK1B,EAAM,MAAM,IAAIQ,CAAE,MAAG,KAAY;EAEvE,IAAMmB,IAAW3B,EAAM,MAAM,OAAOyB,IAAWG;EAC/C,IAAID,KAAY,GAAG;EACnB,IAAIE,IAAU;EACd,KAAK,IAAM,CAACC,GAAKC,MAAU/B,EAAM,OAAO;GACtC,IAAI6B,KAAWF,GAAU;GACzB,AAAID,GAAc,IAAII,CAAG,KAAK3B,EAAO,IAAI2B,CAAG,MACxCC,EAAM,WAAWA,EAAM,iBACzB/B,EAAM,MAAM,OAAO8B,CAAG,GACtB,KAAW;EAEf;CACF,GAEME,KAAa,MAAc;EAC/B,EAAM;EACN,KAAK,IAAMzB,KAAQc,GACjB,EAAM,MAAM,IAAId,EAAKe,IAAc;GACjC,GAAGC,EAAiBhB,CAAI;GACxB,SAAS;EACX,CAAC;CAEL,GAEM0B,KAAiB,MAAkB;EACvC,KAAK,IAAMzB,KAAM0B,GACf,EAAQ,MAAM,OAAO1B,CAAE;CAE3B,GAEM2B,KAAkB,GAAe,MAAmC;EACxE,KAAK,IAAM3B,KAAM0B,GAAK;GACpB,IAAM3B,IAAOP,EAAM,MAAM,IAAIQ,CAAE;GAC/B,AAAIC,EAAYF,CAAI,KAAKA,EAAK,WAC9BP,EAAM,MAAM,IAAIQ,GAAI;IAAE,GAAGD;IAAM,aAAa;IAAM,mBAAmB6B;GAAO,CAAC;EAC/E;CACF,GAEMC,IAAa,OAAO,MAA2B;EACnD,IAAI;GAGF,IAAMC,IAAM,MAAMC,EAAcL,CAAG;GAMnC,OALAF,EAAUM,CAAG,GACbH,EAAeD,GAAK,UAAU,GAG9BhB,EAAM,GACCoB;EACT,SAASlD,GAAgB;GAGvB,MAFA+C,EAAeD,GAAK5C,EAAiBF,CAAK,CAAC,GAC3C8B,EAAM,GACA9B;EACR;CACF,GAIMoD,IAAa,OAAO,MAAa;EACrC,IAAMC,IAAa,CAAC,GACdC,IAAsB,CAAC;EAC7B,KAAK,IAAIC,IAAQ,GAAGA,IAAQT,EAAI,QAAQ,KAASnC,GAC/C,IAAI;GACF,EAAM,KAAK,GAAI,MAAMsC,EAAWH,EAAI,MAAMS,GAAOA,IAAQ5C,CAAS,CAAC,CAAE;EACvE,SAASX,GAAgB;GACvB,EAAS,KAAKA,CAAK;EACrB;EAEF,OAAO;GAAE;GAAO;EAAS;CAC3B,GAGMwD,IAAW,YAAY;EAC3B,IAAI1C,EAAQ,MAAM,SAAS,GAAG,OAAO;GAAE,OAAO,CAAC;GAAU,UAAU,CAAC;EAAe;EACnF,IAAMgC,IAAM,MAAM,KAAKhC,EAAQ,KAAK;EAKpC,EAAcgC,CAAG;EACjB,IAAMW,IAAML,EAAWN,CAAG;EAC1B,EAAS,IAAIW,CAAG;EAChB,IAAI;GACF,OAAO,MAAMA;EACf,UAAU;GACR,EAAS,OAAOA,CAAG;EACrB;CACF;CAEA,eAAeC,IAAW;EACxB,IAAM,EAAE,UAAO,gBAAa,MAAMF,EAAS;EAC3C,IAAIF,EAAS,SAAS,GAAG,MAAMA,EAAS;EACxC,OAAOD;CACT;CAEA,IAAMM,KAAc,MAAmB;EACrC,AAAIxD,EAAQH,CAAK,KACjB4D,EAAS5D,aAAiB,QAAQA,IAAY,MAAM,OAAOA,CAAK,CAAC,GAAG;GAClE,OAAO;GACP,MAAM,EAAE,aAAa,SAAS;EAChC,CAAC;CACH,GAKM6D,IAAiBC,EACrB,YAAY;EACV,IAAI;GAEF,IAAM,EAAE,UAAO,gBAAa,MAAMN,EAAS;GAE3C,OADAF,EAAS,QAAQK,CAAU,GACpBN;EACT,SAASrD,GAAgB;GAEvB,OADA2D,EAAW3D,CAAK,GACT,CAAC;EACV;CACF,GACA,MACA,EAAE,SAAS,IAAK,CAClB;CAsEA,OAAO;EACL;EACA;EACA,aAlEO6D,EAAe;EAmEtB,4BAzDiC;GACjC,IAAME,IAAU,MAAM,KAAK/C,CAAQ,GAC7BgD,IAAM,MAAMN,EAAS,GACrBO,IAAS,MAAM,QAAQ,IAAIF,CAAO;GACxC,OAAO,CAAC,GAAGC,GAAK,GAAGC,EAAO,SAAS,MAAUC,EAAM,KAAK,CAAC;EAC3D;EAqDE;EACA;EACA;EACA,MArDW,MAA6B;GACxC,AAAK9C,KACLL,EAAO,IAAIK,IAAKL,EAAO,IAAIK,CAAE,KAAK,KAAK,CAAC;EAC1C;EAmDE,QAhDa,MAA6B;GAC1C,IAAI,CAACA,GAAI;GACT,IAAM+C,IAAQpD,EAAO,IAAIK,CAAE;GAC3B,AAAIC,EAAY8C,CAAK,MACjBA,IAAQ,IACVpD,EAAO,IAAIK,GAAI+C,IAAQ,CAAC,KAG1BpD,EAAO,OAAOK,CAAE,GAChBU,EAAM;EACR;EAuCE,MAhCW,MACNV,IACER,EAAM,MAAM,IAAIQ,CAAE,IADT;EAgChB,MAtCW,MAA6B;GACxC,IAAKA,GACL,OAAOR,EAAM,MAAM,IAAIQ,CAAE;EAC3B;EAoCE,aA5BOR,EAAM,MAAM,MAAM;EA6BzB,WA1BgB,MAAsC;GACtD,IAAI,CAACQ,GAAI,OAAO;GAChB,IAAMD,IAAOP,EAAM,MAAM,IAAIQ,CAAE;GAE/B,OADKD,IACEA,EAAK,UADM;EAEpB;EAsBE,eAnBoB,MACfC,IACER,EAAM,MAAM,IAAIQ,CAAE,CAAC,EAAE,gBAAgB,KAD5B;CAmBlB;AACF"}

package/dist/domains/cached/composables/useCachedItem.d.ts

@@ -1,20 +1,19 @@
 import { ComputedRef } from 'vue';
 import { DocId, IntegerId } from '../../../shared/types/common';
-/** How a component that shows an item of a cache keeps it there, and has it asked for (`useCachedItem`). */
+/** How a component showing a cached item keeps it pinned and requests it (`useCachedItem`). */
 export interface CachedItemPinning<I extends DocId | IntegerId> {
-    /** The id the component shows the item of; none while it shows none (it is given a title of its own). */
+    /** Id of the shown item. None while the component shows none, e.g. when it has its own title. */
     id: () => I | null | undefined;
-    /** `pin` and `unpin` of the cache (`defineCached`). */
     pin: (id: I) => void;
     unpin: (id: I) => void;
-    /** Adds the id to the cache and has it fetched, for an id the cache does not have: one its page never added. */
+    /** Adds the id to the cache and fetches it, for an id its page never added. */
     askFor: (id: I) => void;
 }
 /**
- * `pinning`: the item shown is pinned in its cache while the component shows it, from the start and across a change
- * of its id, and let go as the component goes. The cache, which keeps 1 000 items, drops no pinned one: a chip whose
- * name it had dropped spun till something added the id again. An id the cache does not have is asked for once, as it
- * is shown.
+ * `pinning`: the shown item stays pinned in its cache while the
+ * component shows it, across id changes, and is released on unmount.
+ * The cache (1 000 items) never drops pinned items. Without this a chip spun after its item was dropped.
+ * An id the cache does not have is requested once when shown.
  */
 export declare function useCachedItem<T extends {
     _loaded?: boolean;

package/dist/domains/cached/composables/useCachedItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"useCachedItem.js","names":["useCachedItem","pinning","shown","watch","before","id","getter","onScopeDispose","cached","computed","value"],"sources":["../../../../src/domains/cached/composables/useCachedItem.ts"],"sourcesContent":["import { type ComputedRef, computed, onScopeDispose, watch } from 'vue'\nimport type { DocId, IntegerId } from '@/shared/types/common'\n\n/** How a component that shows an item of a cache keeps it there, and has it asked for (`useCachedItem`). */\nexport interface CachedItemPinning<I extends DocId | IntegerId> {\n  /** The id the component shows the item of; none while it shows none (it is given a title of its own). */\n  id: () => I | null | undefined\n  /** `pin` and `unpin` of the cache (`defineCached`). */\n  pin: (id: I) => void\n  unpin: (id: I) => void\n  /** Adds the id to the cache and has it fetched, for an id the cache does not have: one its page never added. */\n  askFor: (id: I) => void\n}\n\n/**\n * `pinning`: the item shown is pinned in its cache while the component shows it, from the start and across a change\n * of its id, and let go as the component goes. The cache, which keeps 1 000 items, drops no pinned one: a chip whose\n * name it had dropped spun till something added the id again. An id the cache does not have is asked for once, as it\n * is shown.\n */\nexport function useCachedItem<\n  T extends { _loaded?: boolean; _unresolved?: boolean },\n  I extends DocId | IntegerId = DocId | IntegerId,\n>(\n  getter: () => T | undefined,\n  pinning?: CachedItemPinning<I>\n): { cached: ComputedRef<T | undefined>; loaded: ComputedRef<boolean>; unresolved: ComputedRef<boolean> } {\n  if (pinning) {\n    let shown: I | null = null\n    watch(\n      pinning.id,\n      (id) => {\n        // The new one first: let go first, the one shown before could have the new one dropped.\n        const before = shown\n        shown = id || null\n        if (shown) pinning.pin(shown)\n        if (before) pinning.unpin(before)\n        if (shown && getter() === undefined) pinning.askFor(shown)\n      },\n      { immediate: true }\n    )\n    onScopeDispose(() => {\n      if (shown) pinning.unpin(shown)\n      shown = null\n    })\n  }\n  const cached = computed<T | undefined>(() => {\n    const value = getter()\n    if (!value) return undefined\n    // `_unresolved` settles the item: return the placeholder so consumers stop showing a spinner.\n    return value._loaded !== false || value._unresolved === true ? value : undefined\n  })\n  const loaded = computed(() => cached.value !== undefined)\n  // Apart from `loaded`, because the placeholder is all an unresolved item has: a consumer reading\n  // its fields would draw an empty chip.\n  const unresolved = computed(() => cached.value?._unresolved === true)\n\n  return { cached, loaded, unresolved }\n}\n"],"mappings":";;AAoBA,SAAgBA,EAId,GACA,GACwG;CACxG,IAAIC,GAAS;EACX,IAAIC,IAAkB;EAatB,AAZAC,EACEF,EAAQ,KACP,MAAO;GAEN,IAAMG,IAASF;GAIf,AAHA,IAAQG,KAAM,MACVH,KAAOD,EAAQ,IAAIC,CAAK,GACxBE,KAAQH,EAAQ,MAAMG,CAAM,GAC5BF,KAASI,EAAO,MAAM,KAAA,KAAWL,EAAQ,OAAOC,CAAK;EAC3D,GACA,EAAE,WAAW,GAAK,CACpB,GACAK,QAAqB;GAEnB,AADIL,KAAOD,EAAQ,MAAMC,CAAK,GAC9B,IAAQ;EACV,CAAC;CACH;CACA,IAAMM,IAASC,QAA8B;EAC3C,IAAMC,IAAQJ,EAAO;EACrB,IAAKI,GAEL,OAAOA,EAAM,YAAY,MAASA,EAAM,gBAAgB,KAAOA,IAAQ,KAAA;CACzE,CAAC;CAMD,OAAO;EAAE;EAAQ,QALFD,QAAeD,EAAO,UAAU,KAAA,CAK9B;EAAQ,YAFNC,QAAeD,EAAO,OAAO,gBAAgB,EAEvC;CAAW;AACtC"}
+{"version":3,"file":"useCachedItem.js","names":["useCachedItem","pinning","shown","watch","before","id","getter","onScopeDispose","cached","computed","value"],"sources":["../../../../src/domains/cached/composables/useCachedItem.ts"],"sourcesContent":["import { type ComputedRef, computed, onScopeDispose, watch } from 'vue'\nimport type { DocId, IntegerId } from '@/shared/types/common'\n\n/** How a component showing a cached item keeps it pinned and requests it (`useCachedItem`). */\nexport interface CachedItemPinning<I extends DocId | IntegerId> {\n  /** Id of the shown item. None while the component shows none, e.g. when it has its own title. */\n  id: () => I | null | undefined\n  pin: (id: I) => void\n  unpin: (id: I) => void\n  /** Adds the id to the cache and fetches it, for an id its page never added. */\n  askFor: (id: I) => void\n}\n\n/**\n * `pinning`: the shown item stays pinned in its cache while the\n * component shows it, across id changes, and is released on unmount.\n * The cache (1 000 items) never drops pinned items. Without this a chip spun after its item was dropped.\n * An id the cache does not have is requested once when shown.\n */\nexport function useCachedItem<\n  T extends { _loaded?: boolean; _unresolved?: boolean },\n  I extends DocId | IntegerId = DocId | IntegerId,\n>(\n  getter: () => T | undefined,\n  pinning?: CachedItemPinning<I>\n): { cached: ComputedRef<T | undefined>; loaded: ComputedRef<boolean>; unresolved: ComputedRef<boolean> } {\n  if (pinning) {\n    let shown: I | null = null\n    watch(\n      pinning.id,\n      (id) => {\n        // Pin the new id first. Unpinning the old one first could let the cache drop the new one.\n        const before = shown\n        shown = id || null\n        if (shown) pinning.pin(shown)\n        if (before) pinning.unpin(before)\n        if (shown && getter() === undefined) pinning.askFor(shown)\n      },\n      { immediate: true }\n    )\n    onScopeDispose(() => {\n      if (shown) pinning.unpin(shown)\n      shown = null\n    })\n  }\n  const cached = computed<T | undefined>(() => {\n    const value = getter()\n    if (!value) return undefined\n    // `_unresolved` settles the item: return the placeholder so consumers stop showing a spinner.\n    return value._loaded !== false || value._unresolved === true ? value : undefined\n  })\n  const loaded = computed(() => cached.value !== undefined)\n  // Separate from `loaded`, because an unresolved item is only a placeholder.\n  // A consumer reading its fields would draw an empty chip.\n  const unresolved = computed(() => cached.value?._unresolved === true)\n\n  return { cached, loaded, unresolved }\n}\n"],"mappings":";;AAmBA,SAAgBA,EAId,GACA,GACwG;CACxG,IAAIC,GAAS;EACX,IAAIC,IAAkB;EAatB,AAZAC,EACEF,EAAQ,KACP,MAAO;GAEN,IAAMG,IAASF;GAIf,AAHA,IAAQG,KAAM,MACVH,KAAOD,EAAQ,IAAIC,CAAK,GACxBE,KAAQH,EAAQ,MAAMG,CAAM,GAC5BF,KAASI,EAAO,MAAM,KAAA,KAAWL,EAAQ,OAAOC,CAAK;EAC3D,GACA,EAAE,WAAW,GAAK,CACpB,GACAK,QAAqB;GAEnB,AADIL,KAAOD,EAAQ,MAAMC,CAAK,GAC9B,IAAQ;EACV,CAAC;CACH;CACA,IAAMM,IAASC,QAA8B;EAC3C,IAAMC,IAAQJ,EAAO;EACrB,IAAKI,GAEL,OAAOA,EAAM,YAAY,MAASA,EAAM,gBAAgB,KAAOA,IAAQ,KAAA;CACzE,CAAC;CAMD,OAAO;EAAE;EAAQ,QALFD,QAAeD,EAAO,UAAU,KAAA,CAK9B;EAAQ,YAFNC,QAAeD,EAAO,OAAO,gBAAgB,EAEvC;CAAW;AACtC"}

package/dist/domains/collab/components/ACollabLockedByUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"ACollabLockedByUser.js","names":["_sfc_main","ACollabLockedByUser_vue_vue_type_script_setup_true_lang_default","ACollabLockedByUser_default"],"sources":["../../../../src/domains/collab/components/ACollabLockedByUser.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport { computed, type Ref, shallowRef, unref, watch } from 'vue'\nimport AAnzuUserAvatar from '@/domains/ui/components/AAnzuUserAvatar.vue'\nimport { isNull, isNumber, isUndefined } from '@/shared/utils/common'\nimport type { CollabCachedUsersMap } from '@/domains/collab/composables/collabHelpers'\nimport type { IntegerId } from '@/shared/types/common'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport { useI18n } from 'vue-i18n'\n\nconst props = withDefaults(\n  defineProps<{\n    id: null | undefined | IntegerId\n    users: CollabCachedUsersMap | Ref<CollabCachedUsersMap>\n    isModerator?: boolean\n  }>(),\n  {\n    isModerator: false,\n  }\n)\n\nconst cached = shallowRef<undefined | AnzuUserMinimal>(undefined)\nconst loaded = shallowRef<boolean>(false)\n\n// eslint-disable-next-line vue/no-setup-props-reactivity-loss\nconst cachedUsers = unref(props.users)\nconst { t } = useI18n()\n\nconst item = computed(() => {\n  if (isNumber(props.id) && props.id > 0) {\n    return cachedUsers.get(props.id)\n  }\n  return undefined\n})\n\nconst tooltip = computed(() => {\n  let prefix = ''\n  if (props.isModerator) {\n    prefix = t('common.collab.moderator') + ': '\n  }\n  if (item.value) {\n    return item.value.person.fullName.length\n      ? prefix + item.value.person.fullName\n      : prefix + item.value.email.split('@')[0]\n  }\n  return undefined\n})\n\nwatch(\n  item,\n  (newValue) => {\n    // Same user still loaded: keep it. A user the cache resolves later (after an `_unresolved` placeholder)\n    // arrives as a new, loaded object under the same id and replaces the placeholder.\n    if (loaded.value && cached.value?.id === newValue?.id && !newValue?._loaded) return\n    loaded.value = false\n    cached.value = undefined\n    if (isUndefined(newValue) || (!newValue._loaded && newValue._unresolved !== true)) return\n    cached.value = newValue\n    loaded.value = true\n  },\n  { immediate: true }\n)\n</script>\n\n<template>\n  <div class=\"d-inline-flex\">\n    <span v-if=\"isNull(id) || isUndefined(id)\" />\n    <template v-else-if=\"loaded\">\n      <VBadge\n        v-if=\"isModerator\"\n        location=\"top right\"\n        color=\"white\"\n        :width=\"12\"\n        :min-width=\"12\"\n        :height=\"14\"\n        :offset-x=\"-5\"\n        :offset-y=\"-5\"\n      >\n        <template #badge>\n          <VIcon\n            color=\"grey-darken-2\"\n            :size=\"14\"\n            icon=\"mdi-crown\"\n          />\n        </template>\n        <AAnzuUserAvatar\n          :user=\"cached ?? undefined\"\n          :size=\"20\"\n          :tooltip=\"tooltip\"\n        />\n      </VBadge>\n      <AAnzuUserAvatar\n        v-else\n        :user=\"cached ?? undefined\"\n        :size=\"20\"\n        :tooltip=\"tooltip\"\n      />\n    </template>\n    <VProgressCircular\n      v-else\n      :size=\"12\"\n      :width=\"2\"\n      indeterminate\n      class=\"ml-auto mr-auto\"\n    />\n  </div>\n</template>\n"],"mappings":""}
+{"version":3,"file":"ACollabLockedByUser.js","names":["_sfc_main","ACollabLockedByUser_vue_vue_type_script_setup_true_lang_default","ACollabLockedByUser_default"],"sources":["../../../../src/domains/collab/components/ACollabLockedByUser.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport { computed, type Ref, shallowRef, unref, watch } from 'vue'\nimport AAnzuUserAvatar from '@/domains/ui/components/AAnzuUserAvatar.vue'\nimport { isNull, isNumber, isUndefined } from '@/shared/utils/common'\nimport type { CollabCachedUsersMap } from '@/domains/collab/composables/collabHelpers'\nimport type { IntegerId } from '@/shared/types/common'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport { useI18n } from 'vue-i18n'\n\nconst props = withDefaults(\n  defineProps<{\n    id: null | undefined | IntegerId\n    users: CollabCachedUsersMap | Ref<CollabCachedUsersMap>\n    isModerator?: boolean\n  }>(),\n  {\n    isModerator: false,\n  }\n)\n\nconst cached = shallowRef<undefined | AnzuUserMinimal>(undefined)\nconst loaded = shallowRef<boolean>(false)\n\n// eslint-disable-next-line vue/no-setup-props-reactivity-loss\nconst cachedUsers = unref(props.users)\nconst { t } = useI18n()\n\nconst item = computed(() => {\n  if (isNumber(props.id) && props.id > 0) {\n    return cachedUsers.get(props.id)\n  }\n  return undefined\n})\n\nconst tooltip = computed(() => {\n  let prefix = ''\n  if (props.isModerator) {\n    prefix = t('common.collab.moderator') + ': '\n  }\n  if (item.value) {\n    return item.value.person.fullName.length\n      ? prefix + item.value.person.fullName\n      : prefix + item.value.email.split('@')[0]\n  }\n  return undefined\n})\n\nwatch(\n  item,\n  (newValue) => {\n    // Same user still loaded: keep it.\n    // A user resolved later (after an `_unresolved` placeholder) arrives as\n    // a new loaded object under the same id and replaces the placeholder.\n    if (loaded.value && cached.value?.id === newValue?.id && !newValue?._loaded) return\n    loaded.value = false\n    cached.value = undefined\n    if (isUndefined(newValue) || (!newValue._loaded && newValue._unresolved !== true)) return\n    cached.value = newValue\n    loaded.value = true\n  },\n  { immediate: true }\n)\n</script>\n\n<template>\n  <div class=\"d-inline-flex\">\n    <span v-if=\"isNull(id) || isUndefined(id)\" />\n    <template v-else-if=\"loaded\">\n      <VBadge\n        v-if=\"isModerator\"\n        location=\"top right\"\n        color=\"white\"\n        :width=\"12\"\n        :min-width=\"12\"\n        :height=\"14\"\n        :offset-x=\"-5\"\n        :offset-y=\"-5\"\n      >\n        <template #badge>\n          <VIcon\n            color=\"grey-darken-2\"\n            :size=\"14\"\n            icon=\"mdi-crown\"\n          />\n        </template>\n        <AAnzuUserAvatar\n          :user=\"cached ?? undefined\"\n          :size=\"20\"\n          :tooltip=\"tooltip\"\n        />\n      </VBadge>\n      <AAnzuUserAvatar\n        v-else\n        :user=\"cached ?? undefined\"\n        :size=\"20\"\n        :tooltip=\"tooltip\"\n      />\n    </template>\n    <VProgressCircular\n      v-else\n      :size=\"12\"\n      :width=\"2\"\n      indeterminate\n      class=\"ml-auto mr-auto\"\n    />\n  </div>\n</template>\n"],"mappings":""}

package/dist/domains/collab/components/ACollabLockedByUser.vue_vue_type_script_setup_true_lang.js.map

@@ -1 +1 @@
-{"version":3,"file":"ACollabLockedByUser.vue_vue_type_script_setup_true_lang.js","names":["_openBlock","_createElementBlock","_unref","_Fragment","_createBlock","_component_VBadge","_withCtx","_createVNode","_component_VIcon","AAnzuUserAvatar","_component_VProgressCircular","AAnzuUserAvatar_default","_hoisted_1","_hoisted_2","ACollabLockedByUser_vue_vue_type_script_setup_true_lang_default","props","__props","cached","shallowRef","loaded","cachedUsers","unref","useI18n","item","computed","isNumber","tooltip","prefix","t","watch","newValue","openBlock","createElementBlock","isNull","isUndefined","Fragment","createBlock","VBadge","withCtx","createVNode","VIcon","VProgressCircular"],"sources":["../../../../src/domains/collab/components/ACollabLockedByUser.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport { computed, type Ref, shallowRef, unref, watch } from 'vue'\nimport AAnzuUserAvatar from '@/domains/ui/components/AAnzuUserAvatar.vue'\nimport { isNull, isNumber, isUndefined } from '@/shared/utils/common'\nimport type { CollabCachedUsersMap } from '@/domains/collab/composables/collabHelpers'\nimport type { IntegerId } from '@/shared/types/common'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport { useI18n } from 'vue-i18n'\n\nconst props = withDefaults(\n  defineProps<{\n    id: null | undefined | IntegerId\n    users: CollabCachedUsersMap | Ref<CollabCachedUsersMap>\n    isModerator?: boolean\n  }>(),\n  {\n    isModerator: false,\n  }\n)\n\nconst cached = shallowRef<undefined | AnzuUserMinimal>(undefined)\nconst loaded = shallowRef<boolean>(false)\n\n// eslint-disable-next-line vue/no-setup-props-reactivity-loss\nconst cachedUsers = unref(props.users)\nconst { t } = useI18n()\n\nconst item = computed(() => {\n  if (isNumber(props.id) && props.id > 0) {\n    return cachedUsers.get(props.id)\n  }\n  return undefined\n})\n\nconst tooltip = computed(() => {\n  let prefix = ''\n  if (props.isModerator) {\n    prefix = t('common.collab.moderator') + ': '\n  }\n  if (item.value) {\n    return item.value.person.fullName.length\n      ? prefix + item.value.person.fullName\n      : prefix + item.value.email.split('@')[0]\n  }\n  return undefined\n})\n\nwatch(\n  item,\n  (newValue) => {\n    // Same user still loaded: keep it. A user the cache resolves later (after an `_unresolved` placeholder)\n    // arrives as a new, loaded object under the same id and replaces the placeholder.\n    if (loaded.value && cached.value?.id === newValue?.id && !newValue?._loaded) return\n    loaded.value = false\n    cached.value = undefined\n    if (isUndefined(newValue) || (!newValue._loaded && newValue._unresolved !== true)) return\n    cached.value = newValue\n    loaded.value = true\n  },\n  { immediate: true }\n)\n</script>\n\n<template>\n  <div class=\"d-inline-flex\">\n    <span v-if=\"isNull(id) || isUndefined(id)\" />\n    <template v-else-if=\"loaded\">\n      <VBadge\n        v-if=\"isModerator\"\n        location=\"top right\"\n        color=\"white\"\n        :width=\"12\"\n        :min-width=\"12\"\n        :height=\"14\"\n        :offset-x=\"-5\"\n        :offset-y=\"-5\"\n      >\n        <template #badge>\n          <VIcon\n            color=\"grey-darken-2\"\n            :size=\"14\"\n            icon=\"mdi-crown\"\n          />\n        </template>\n        <AAnzuUserAvatar\n          :user=\"cached ?? undefined\"\n          :size=\"20\"\n          :tooltip=\"tooltip\"\n        />\n      </VBadge>\n      <AAnzuUserAvatar\n        v-else\n        :user=\"cached ?? undefined\"\n        :size=\"20\"\n        :tooltip=\"tooltip\"\n      />\n    </template>\n    <VProgressCircular\n      v-else\n      :size=\"12\"\n      :width=\"2\"\n      indeterminate\n      class=\"ml-auto mr-auto\"\n    />\n  </div>\n</template>\n"],"mappings":";;;;;;;;;;;;;;;;;;;EASA,IAAMe,IAAQC,GAWRC,IAASC,EAAwC,KAAA,CAAS,GAC1DC,IAASD,EAAoB,EAAK,GAGlCE,IAAcC,EAAMN,EAAM,KAAK,GAC/B,EAAE,SAAMO,EAAQ,GAEhBC,IAAOC,QAAe;GAC1B,IAAIC,EAASV,EAAM,EAAE,KAAKA,EAAM,KAAK,GACnC,OAAOK,EAAY,IAAIL,EAAM,EAAE;EAGnC,CAAC,GAEKW,IAAUF,QAAe;GAC7B,IAAIG,IAAS;GAIb,IAHIZ,EAAM,gBACR,IAASa,EAAE,yBAAyB,IAAI,OAEtCL,EAAK,OACP,OAAOA,EAAK,MAAM,OAAO,SAAS,SAC9BI,IAASJ,EAAK,MAAM,OAAO,WAC3BI,IAASJ,EAAK,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC;EAG7C,CAAC;E,OAEDM,EACEN,IACC,MAAa;GAGZ,CAAI,GAAO,SAASN,EAAO,OAAO,OAAOa,GAAU,MAAOA,GAAU,aACpE,EAAO,QAAQ,IACf,EAAO,QAAQ,KAAA,GACX,IAAYA,CAAQ,KAAM,CAACA,EAAS,WAAWA,EAAS,gBAAgB,QAC5E,EAAO,QAAQA,GACf,EAAO,QAAQ;EACjB,GACA,EAAE,WAAW,GAAK,CACpB,I,UAIE9B,EAAA,GAAAC,EAwCM,OAxCNW,GAwCM,CAvCQV,EAAA+B,CAAA,CAAM,CAACjB,EAAA,EAAE,KAAKd,EAAAgC,CAAA,CAAW,CAAClB,EAAA,EAAE,KAAxChB,EAAA,GAAAC,EAA6C,QAAAY,CAAA,KACxBM,EAAA,SAArBnB,EAAA,GAAAC,EA8BWE,GAAA,EAAA,KAAA,EAAA,GAAA,CA5BDa,EAAA,eADRhB,EAAA,GAAAI,EAsBSC,GAAA;;GApBP,UAAS;GACT,OAAM;GACL,OAAO;GACP,aAAW;GACX,QAAQ;GACR,YAAU;GACV,YAAU;;GAEA,OAAKC,QAKZ,CAJFC,EAIEC,GAAA;IAHA,OAAM;IACL,MAAM;IACP,MAAK;;GAGT,SAAAF,QAIE,CAJFC,EAIEE,GAAA;IAHC,MAAMQ,EAAA,SAAU,KAAA;IAChB,MAAM;IACN,SAASS,EAAA;;;E,OAGd1B,EAAA,GAAAI,EAKEK,GAAA;;GAHC,MAAMQ,EAAA,SAAU,KAAA;GAChB,MAAM;GACN,SAASS,EAAA;E,4CAGd1B,EAAA,GAAAI,EAMEM,GAAA;;GAJC,MAAM;GACN,OAAO;GACR,eAAA;GACA,OAAM"}
+{"version":3,"file":"ACollabLockedByUser.vue_vue_type_script_setup_true_lang.js","names":["_openBlock","_createElementBlock","_unref","_Fragment","_createBlock","_component_VBadge","_withCtx","_createVNode","_component_VIcon","AAnzuUserAvatar","_component_VProgressCircular","AAnzuUserAvatar_default","_hoisted_1","_hoisted_2","ACollabLockedByUser_vue_vue_type_script_setup_true_lang_default","props","__props","cached","shallowRef","loaded","cachedUsers","unref","useI18n","item","computed","isNumber","tooltip","prefix","t","watch","newValue","openBlock","createElementBlock","isNull","isUndefined","Fragment","createBlock","VBadge","withCtx","createVNode","VIcon","VProgressCircular"],"sources":["../../../../src/domains/collab/components/ACollabLockedByUser.vue"],"sourcesContent":["<script lang=\"ts\" setup>\nimport { computed, type Ref, shallowRef, unref, watch } from 'vue'\nimport AAnzuUserAvatar from '@/domains/ui/components/AAnzuUserAvatar.vue'\nimport { isNull, isNumber, isUndefined } from '@/shared/utils/common'\nimport type { CollabCachedUsersMap } from '@/domains/collab/composables/collabHelpers'\nimport type { IntegerId } from '@/shared/types/common'\nimport type { AnzuUserMinimal } from '@/shared/types/AnzuUser'\nimport { useI18n } from 'vue-i18n'\n\nconst props = withDefaults(\n  defineProps<{\n    id: null | undefined | IntegerId\n    users: CollabCachedUsersMap | Ref<CollabCachedUsersMap>\n    isModerator?: boolean\n  }>(),\n  {\n    isModerator: false,\n  }\n)\n\nconst cached = shallowRef<undefined | AnzuUserMinimal>(undefined)\nconst loaded = shallowRef<boolean>(false)\n\n// eslint-disable-next-line vue/no-setup-props-reactivity-loss\nconst cachedUsers = unref(props.users)\nconst { t } = useI18n()\n\nconst item = computed(() => {\n  if (isNumber(props.id) && props.id > 0) {\n    return cachedUsers.get(props.id)\n  }\n  return undefined\n})\n\nconst tooltip = computed(() => {\n  let prefix = ''\n  if (props.isModerator) {\n    prefix = t('common.collab.moderator') + ': '\n  }\n  if (item.value) {\n    return item.value.person.fullName.length\n      ? prefix + item.value.person.fullName\n      : prefix + item.value.email.split('@')[0]\n  }\n  return undefined\n})\n\nwatch(\n  item,\n  (newValue) => {\n    // Same user still loaded: keep it.\n    // A user resolved later (after an `_unresolved` placeholder) arrives as\n    // a new loaded object under the same id and replaces the placeholder.\n    if (loaded.value && cached.value?.id === newValue?.id && !newValue?._loaded) return\n    loaded.value = false\n    cached.value = undefined\n    if (isUndefined(newValue) || (!newValue._loaded && newValue._unresolved !== true)) return\n    cached.value = newValue\n    loaded.value = true\n  },\n  { immediate: true }\n)\n</script>\n\n<template>\n  <div class=\"d-inline-flex\">\n    <span v-if=\"isNull(id) || isUndefined(id)\" />\n    <template v-else-if=\"loaded\">\n      <VBadge\n        v-if=\"isModerator\"\n        location=\"top right\"\n        color=\"white\"\n        :width=\"12\"\n        :min-width=\"12\"\n        :height=\"14\"\n        :offset-x=\"-5\"\n        :offset-y=\"-5\"\n      >\n        <template #badge>\n          <VIcon\n            color=\"grey-darken-2\"\n            :size=\"14\"\n            icon=\"mdi-crown\"\n          />\n        </template>\n        <AAnzuUserAvatar\n          :user=\"cached ?? undefined\"\n          :size=\"20\"\n          :tooltip=\"tooltip\"\n        />\n      </VBadge>\n      <AAnzuUserAvatar\n        v-else\n        :user=\"cached ?? undefined\"\n        :size=\"20\"\n        :tooltip=\"tooltip\"\n      />\n    </template>\n    <VProgressCircular\n      v-else\n      :size=\"12\"\n      :width=\"2\"\n      indeterminate\n      class=\"ml-auto mr-auto\"\n    />\n  </div>\n</template>\n"],"mappings":";;;;;;;;;;;;;;;;;;;EASA,IAAMe,IAAQC,GAWRC,IAASC,EAAwC,KAAA,CAAS,GAC1DC,IAASD,EAAoB,EAAK,GAGlCE,IAAcC,EAAMN,EAAM,KAAK,GAC/B,EAAE,SAAMO,EAAQ,GAEhBC,IAAOC,QAAe;GAC1B,IAAIC,EAASV,EAAM,EAAE,KAAKA,EAAM,KAAK,GACnC,OAAOK,EAAY,IAAIL,EAAM,EAAE;EAGnC,CAAC,GAEKW,IAAUF,QAAe;GAC7B,IAAIG,IAAS;GAIb,IAHIZ,EAAM,gBACR,IAASa,EAAE,yBAAyB,IAAI,OAEtCL,EAAK,OACP,OAAOA,EAAK,MAAM,OAAO,SAAS,SAC9BI,IAASJ,EAAK,MAAM,OAAO,WAC3BI,IAASJ,EAAK,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC;EAG7C,CAAC;E,OAEDM,EACEN,IACC,MAAa;GAIZ,CAAI,GAAO,SAASN,EAAO,OAAO,OAAOa,GAAU,MAAOA,GAAU,aACpE,EAAO,QAAQ,IACf,EAAO,QAAQ,KAAA,GACX,IAAYA,CAAQ,KAAM,CAACA,EAAS,WAAWA,EAAS,gBAAgB,QAC5E,EAAO,QAAQA,GACf,EAAO,QAAQ;EACjB,GACA,EAAE,WAAW,GAAK,CACpB,I,UAIE9B,EAAA,GAAAC,EAwCM,OAxCNW,GAwCM,CAvCQV,EAAA+B,CAAA,CAAM,CAACjB,EAAA,EAAE,KAAKd,EAAAgC,CAAA,CAAW,CAAClB,EAAA,EAAE,KAAxChB,EAAA,GAAAC,EAA6C,QAAAY,CAAA,KACxBM,EAAA,SAArBnB,EAAA,GAAAC,EA8BWE,GAAA,EAAA,KAAA,EAAA,GAAA,CA5BDa,EAAA,eADRhB,EAAA,GAAAI,EAsBSC,GAAA;;GApBP,UAAS;GACT,OAAM;GACL,OAAO;GACP,aAAW;GACX,QAAQ;GACR,YAAU;GACV,YAAU;;GAEA,OAAKC,QAKZ,CAJFC,EAIEC,GAAA;IAHA,OAAM;IACL,MAAM;IACP,MAAK;;GAGT,SAAAF,QAIE,CAJFC,EAIEE,GAAA;IAHC,MAAMQ,EAAA,SAAU,KAAA;IAChB,MAAM;IACN,SAASS,EAAA;;;E,OAGd1B,EAAA,GAAAI,EAKEK,GAAA;;GAHC,MAAMQ,EAAA,SAAU,KAAA;GAChB,MAAM;GACN,SAASS,EAAA;E,4CAGd1B,EAAA,GAAAI,EAMEM,GAAA;;GAJC,MAAM;GACN,OAAO;GACR,eAAA;GACA,OAAM"}

package/dist/domains/collab/composables/collabAnyDataChange.js.map

@@ -1 +1 @@
-{"version":3,"file":"collabAnyDataChange.js","names":["useCollabAnyDataChange","useCommonAdminCollabOptions","useCollabCurrentUserId","useCollabStateInternal","changeEventBus","useCollabRoomDataChangeEventBus","fieldLockStatusEventBus","useCollabFieldLockStatusEventBus","anyChangeCallback","ref","unsubscribeCollabAnyDataChangeListener","anyChangeEventBusListener","event","room","isUndefined","payload","tryOnBeforeUnmount","disableAutoUnsubscribe","isDefined","callback","collabOptions","collabSocket","roomInfo","collabRoomInfoState","CollabStatus","field","data","object","unref","objectToUpdate","cloneDeep","options","statusEvent","error","setFieldLockUnanswered","isCollabFailedChangeRoomLockCallback","response","createFieldLockStatusPayload","CollabFieldLockType","CollabFieldLockStatus","isCollabSuccessChangeRoomLockCallback","collabFieldLocksState","locks","lock","collabFieldDataBufferState","fieldLockMaybeHeld","currentUserId"],"sources":["../../../../src/domains/collab/composables/collabAnyDataChange.ts"],"sourcesContent":["import {\n  type CollabChangeRoomLockCallbackTypes,\n  type CollabFieldData,\n  type CollabFieldDataEnvelope,\n  type CollabFieldLockOptions,\n  type CollabFieldName,\n  type CollabRoom,\n  CollabStatus,\n  isCollabFailedChangeRoomLockCallback,\n  isCollabSuccessChangeRoomLockCallback,\n} from '@/domains/collab/types/Collab'\nimport { type MaybeRef, ref, unref } from 'vue'\nimport {\n  CollabFieldLockStatus,\n  type CollabFieldLockStatusEvent,\n  CollabFieldLockType,\n  type CollabRoomDataChangedEvent,\n  createFieldLockStatusPayload,\n  useCollabFieldLockStatusEventBus,\n  useCollabRoomDataChangeEventBus,\n} from '@/domains/collab/composables/collabEventBus'\nimport { type Fn, tryOnBeforeUnmount } from '@vueuse/core'\nimport { useCommonAdminCollabOptions } from '@/domains/collab/composables/commonAdminCollabOptions'\nimport { useCollabStateInternal } from '@/domains/collab/composables/collabState'\nimport { useCollabCurrentUserId } from '@/domains/collab/composables/collabCurrentUserId'\nimport { cloneDeep, isDefined, isUndefined } from '@/shared/utils/common'\nimport { objectSetValueByPath } from '@/shared/utils/object'\n\nexport function useCollabAnyDataChange(room: CollabRoom, disableAutoUnsubscribe = false) {\n  const { collabOptions } = useCommonAdminCollabOptions()\n  const { currentUserId } = useCollabCurrentUserId()\n  const {\n    collabSocket,\n    collabFieldLocksState,\n    collabFieldDataBufferState,\n    collabRoomInfoState,\n    setFieldLockUnanswered,\n    fieldLockMaybeHeld,\n  } = useCollabStateInternal()\n  const changeEventBus = useCollabRoomDataChangeEventBus()\n  const fieldLockStatusEventBus = useCollabFieldLockStatusEventBus()\n\n  const anyChangeCallback = ref<undefined | ((field: CollabFieldName, payload: CollabFieldDataEnvelope) => void)>()\n  const unsubscribeCollabAnyDataChangeListener = ref<undefined | Fn>()\n\n  const anyChangeEventBusListener = (event: CollabRoomDataChangedEvent, payload?: CollabFieldDataEnvelope) => {\n    if (event.room !== room || isUndefined(payload) || isUndefined(anyChangeCallback.value)) {\n      return\n    }\n    anyChangeCallback.value(event.field, payload)\n  }\n\n  const addCollabAnyDataChangeListener = (\n    callback: (field: CollabFieldName, data: CollabFieldDataEnvelope) => void\n  ) => {\n    anyChangeCallback.value = callback\n    unsubscribeCollabAnyDataChangeListener.value = changeEventBus.on(anyChangeEventBusListener)\n  }\n\n  const changeCollabAnyData = (field: CollabFieldName, data: CollabFieldData, callback: Fn | undefined = undefined) => {\n    if (!collabOptions.value.enabled || isUndefined(collabSocket.value)) return\n    const roomInfo = collabRoomInfoState.get(room)\n    if (roomInfo && roomInfo.status === CollabStatus.Inactive) return\n    collabSocket.value.emit('changeFieldData', room, field, data, () => {\n      if (!isUndefined(callback)) callback()\n    })\n  }\n\n  const objectSetDataByField = <T extends object>(\n    field: CollabFieldName,\n    data: CollabFieldDataEnvelope,\n    objectToUpdate: MaybeRef<T>\n  ) => {\n    const object = unref(objectToUpdate)\n    switch (data.type) {\n      case 'json':\n        {\n          objectSetValueByPath(object, field, cloneDeep(data.value))\n        }\n        break\n      default: {\n        objectSetValueByPath(object, field, data.value)\n      }\n    }\n  }\n\n  tryOnBeforeUnmount(() => {\n    if (disableAutoUnsubscribe) return\n    if (isDefined(unsubscribeCollabAnyDataChangeListener.value)) {\n      unsubscribeCollabAnyDataChangeListener.value()\n    }\n  })\n\n  const acquireCollabAnyLock = (field: CollabFieldName, options: Partial<CollabFieldLockOptions> = {}) => {\n    if (!collabOptions.value.enabled || isUndefined(collabSocket.value)) return\n    const roomInfo = collabRoomInfoState.get(room)\n    if (roomInfo && roomInfo.status === CollabStatus.Inactive) return\n    collabSocket.value\n      ?.timeout(1000)\n      .emit('acquireFieldLock', room, field, options, (error, response: CollabChangeRoomLockCallbackTypes) => {\n        const statusEvent: CollabFieldLockStatusEvent = { field, room }\n        if (error) setFieldLockUnanswered(room, field, true)\n        if (error || isCollabFailedChangeRoomLockCallback(response)) {\n          return void fieldLockStatusEventBus.emit(\n            statusEvent,\n            createFieldLockStatusPayload(CollabFieldLockType.Acquire, CollabFieldLockStatus.Failure)\n          )\n        }\n        if (isCollabSuccessChangeRoomLockCallback(response)) {\n          if (!collabFieldLocksState.has(room)) {\n            collabFieldLocksState.set(room, new Map())\n          }\n          const locks = new Map(response.locks ? Object.entries(response.locks) : [])\n          for (const [field, lock] of locks.entries()) {\n            collabFieldLocksState.get(room)?.set(field, lock)\n          }\n\n          return void fieldLockStatusEventBus.emit(\n            statusEvent,\n            createFieldLockStatusPayload(CollabFieldLockType.Acquire, CollabFieldLockStatus.Success)\n          )\n        }\n      })\n  }\n\n  const releaseCollabAnyLock = (\n    field: CollabFieldName,\n    data: CollabFieldData,\n    options: Partial<CollabFieldLockOptions> = {}\n  ) => {\n    if (!collabOptions.value.enabled || isUndefined(collabSocket.value)) return\n    const roomInfo = collabRoomInfoState.get(room)\n    if (roomInfo && roomInfo.status === CollabStatus.Inactive) {\n      if (!collabFieldDataBufferState.has(room)) {\n        collabFieldDataBufferState.set(room, new Map())\n      }\n      collabFieldDataBufferState.get(room)?.set(field, data)\n      // As `useCollabField` does: a lock held while the other editor left is released on the server too.\n      if (!collabSocket.value.connected || !fieldLockMaybeHeld(room, field, currentUserId.value)) return\n    }\n    collabSocket.value\n      ?.timeout(1000)\n      .emit('releaseFieldLock', room, field, data, options, (error, response: CollabChangeRoomLockCallbackTypes) => {\n        const statusEvent: CollabFieldLockStatusEvent = { field, room }\n        if (error || isCollabFailedChangeRoomLockCallback(response)) {\n          return void fieldLockStatusEventBus.emit(\n            statusEvent,\n            createFieldLockStatusPayload(CollabFieldLockType.Release, CollabFieldLockStatus.Failure)\n          )\n        }\n        if (isCollabSuccessChangeRoomLockCallback(response)) {\n          setFieldLockUnanswered(room, field, false)\n          if (!collabFieldLocksState.has(room)) {\n            collabFieldLocksState.set(room, new Map())\n          }\n          if (response.locks) {\n            for (const field of Object.keys(response.locks)) {\n              collabFieldLocksState.get(room)?.delete(field)\n            }\n          }\n\n          return void fieldLockStatusEventBus.emit(\n            statusEvent,\n            createFieldLockStatusPayload(CollabFieldLockType.Release, CollabFieldLockStatus.Success)\n          )\n        }\n      })\n  }\n\n  return {\n    addCollabAnyDataChangeListener,\n    unsubscribeCollabAnyDataChangeListener,\n    changeCollabAnyData,\n    objectSetDataByField,\n    acquireCollabAnyLock,\n    releaseCollabAnyLock,\n  }\n}\n"],"mappings":";;;;;;;;;;AA4BA,SAAgBA,EAAuB,GAAkB,IAAyB,IAAO;CACvF,IAAM,EAAE,qBAAkBC,EAA4B,GAChD,EAAE,qBAAkBC,EAAuB,GAC3C,EACJ,iBACA,0BACA,+BACA,wBACA,2BACA,0BACEC,EAAuB,GACrBC,IAAiBC,EAAgC,GACjDC,IAA0BC,EAAiC,GAE3DC,IAAoBC,EAAsF,GAC1GC,IAAyCD,EAAoB,GAE7DE,KAA6B,GAAmC,MAAsC;EAC1G,AAAIC,EAAM,SAASC,KAAQC,EAAYC,CAAO,KAAKD,EAAYN,EAAkB,KAAK,KAGtFA,EAAkB,MAAMI,EAAM,OAAOG,CAAO;CAC9C;CAuHA,OAnFAC,QAAyB;EACvB,AAAIC,KACAC,EAAUR,EAAuC,KAAK,KACxDA,EAAuC,MAAM;CAEjD,CAAC,GA8EM;EACL,iCArHA,MACG;GAEH,AADA,EAAkB,QAAQS,GAC1B,EAAuC,QAAQf,EAAe,GAAGO,CAAyB;EAC5F;EAkHE;EACA,sBAjH2B,GAAwB,GAAuB,IAA2B,KAAA,MAAc;GACnH,IAAI,CAACS,EAAc,MAAM,WAAWN,EAAYO,EAAa,KAAK,GAAG;GACrE,IAAMC,IAAWC,EAAoB,IAAIV,CAAI;GAC7C,AAAIS,KAAYA,EAAS,WAAWE,EAAa,YACjDH,EAAa,MAAM,KAAK,mBAAmBR,GAAMY,GAAOC,SAAY;IAClE,AAAKZ,EAAYK,CAAQ,KAAGA,EAAS;GACvC,CAAC;EACH;EA2GE,uBAxGA,GACA,GACA,MACG;GACH,IAAMQ,IAASC,EAAMC,CAAc;GACnC,QAAQH,EAAK,MAAb;IACE,KAAK;KAED,EAAqBC,GAAQF,GAAOK,EAAUJ,EAAK,KAAK,CAAC;KAE3D;IACF,SACE,EAAqBC,GAAQF,GAAOC,EAAK,KAAK;GAElD;EACF;EA0FE,uBAjF4B,GAAwB,IAA2C,CAAC,MAAM;GACtG,IAAI,CAACN,EAAc,MAAM,WAAWN,EAAYO,EAAa,KAAK,GAAG;GACrE,IAAMC,IAAWC,EAAoB,IAAIV,CAAI;GAC7C,AAAIS,KAAYA,EAAS,WAAWE,EAAa,YACjDH,EAAa,OACT,QAAQ,GAAI,CAAC,CACd,KAAK,oBAAoBR,GAAMY,GAAOM,IAAU,GAAO,MAAgD;IACtG,IAAMC,IAA0C;KAAE;KAAO;IAAK;IAE9D,IADIC,KAAOC,EAAuBrB,GAAMY,GAAO,EAAI,GAC/CQ,KAASE,EAAqCC,CAAQ,GACjD,EAA6B,KAClCJ,GACAK,EAA6BC,EAAoB,SAASC,EAAsB,OAAO,CACzF;SAEF,IAAIC,EAAsCJ,CAAQ,GAAG;KACnD,AAAKK,EAAsB,IAAI5B,CAAI,KACjC4B,EAAsB,IAAI5B,mBAAM,IAAI,IAAI,CAAC;KAE3C,IAAM6B,IAAQ,IAAI,IAAIN,EAAS,QAAQ,OAAO,QAAQA,EAAS,KAAK,IAAI,CAAC,CAAC;KAC1E,KAAK,IAAM,CAACX,GAAOkB,MAASD,EAAM,QAAQ,GACxC,EAAsB,IAAI7B,CAAI,CAAC,EAAE,IAAIY,GAAOkB,CAAI;KAG3C,EAA6B,KAClCX,GACAK,EAA6BC,EAAoB,SAASC,EAAsB,OAAO,CACzF;IACF;GACF,CAAC;EACL;EAoDE,uBAjDA,GACA,GACA,IAA2C,CAAC,MACzC;GACH,IAAI,CAACnB,EAAc,MAAM,WAAWN,EAAYO,EAAa,KAAK,GAAG;GACrE,IAAMC,IAAWC,EAAoB,IAAIV,CAAI;GAC7C,AAAIS,KAAYA,EAAS,WAAWE,EAAa,aAC1CoB,EAA2B,IAAI/B,CAAI,KACtC+B,EAA2B,IAAI/B,mBAAM,IAAI,IAAI,CAAC,GAEhD+B,EAA2B,IAAI/B,CAAI,CAAC,EAAE,IAAIY,GAAOC,CAAI,GAEjD,CAACL,EAAa,MAAM,aAAa,CAACwB,EAAmBhC,GAAMY,GAAOqB,EAAc,KAAK,MAE3FzB,EAAa,OACT,QAAQ,GAAI,CAAC,CACd,KAAK,oBAAoBR,GAAMY,GAAOC,GAAMK,IAAU,GAAO,MAAgD;IAC5G,IAAMC,IAA0C;KAAE;KAAO;IAAK;IAC9D,IAAIC,KAASE,EAAqCC,CAAQ,GACjD,EAA6B,KAClCJ,GACAK,EAA6BC,EAAoB,SAASC,EAAsB,OAAO,CACzF;SAEF,IAAIC,EAAsCJ,CAAQ,GAAG;KAKnD,IAJAF,EAAuBrB,GAAMY,GAAO,EAAK,GACpCgB,EAAsB,IAAI5B,CAAI,KACjC4B,EAAsB,IAAI5B,mBAAM,IAAI,IAAI,CAAC,GAEvCuB,EAAS,OACX,KAAK,IAAMX,KAAS,OAAO,KAAKW,EAAS,KAAK,GAC5C,EAAsB,IAAIvB,CAAI,CAAC,EAAE,OAAOY,CAAK;KAI1C,EAA6B,KAClCO,GACAK,EAA6BC,EAAoB,SAASC,EAAsB,OAAO,CACzF;IACF;GACF,CAAC;EACL;CASA;AACF"}
+{"version":3,"file":"collabAnyDataChange.js","names":["useCollabAnyDataChange","useCommonAdminCollabOptions","useCollabCurrentUserId","useCollabStateInternal","changeEventBus","useCollabRoomDataChangeEventBus","fieldLockStatusEventBus","useCollabFieldLockStatusEventBus","anyChangeCallback","ref","unsubscribeCollabAnyDataChangeListener","anyChangeEventBusListener","event","room","isUndefined","payload","tryOnBeforeUnmount","disableAutoUnsubscribe","isDefined","callback","collabOptions","collabSocket","roomInfo","collabRoomInfoState","CollabStatus","field","data","object","unref","objectToUpdate","cloneDeep","options","statusEvent","error","setFieldLockUnanswered","isCollabFailedChangeRoomLockCallback","response","createFieldLockStatusPayload","CollabFieldLockType","CollabFieldLockStatus","isCollabSuccessChangeRoomLockCallback","collabFieldLocksState","locks","lock","collabFieldDataBufferState","fieldLockMaybeHeld","currentUserId"],"sources":["../../../../src/domains/collab/composables/collabAnyDataChange.ts"],"sourcesContent":["import {\n  type CollabChangeRoomLockCallbackTypes,\n  type CollabFieldData,\n  type CollabFieldDataEnvelope,\n  type CollabFieldLockOptions,\n  type CollabFieldName,\n  type CollabRoom,\n  CollabStatus,\n  isCollabFailedChangeRoomLockCallback,\n  isCollabSuccessChangeRoomLockCallback,\n} from '@/domains/collab/types/Collab'\nimport { type MaybeRef, ref, unref } from 'vue'\nimport {\n  CollabFieldLockStatus,\n  type CollabFieldLockStatusEvent,\n  CollabFieldLockType,\n  type CollabRoomDataChangedEvent,\n  createFieldLockStatusPayload,\n  useCollabFieldLockStatusEventBus,\n  useCollabRoomDataChangeEventBus,\n} from '@/domains/collab/composables/collabEventBus'\nimport { type Fn, tryOnBeforeUnmount } from '@vueuse/core'\nimport { useCommonAdminCollabOptions } from '@/domains/collab/composables/commonAdminCollabOptions'\nimport { useCollabStateInternal } from '@/domains/collab/composables/collabState'\nimport { useCollabCurrentUserId } from '@/domains/collab/composables/collabCurrentUserId'\nimport { cloneDeep, isDefined, isUndefined } from '@/shared/utils/common'\nimport { objectSetValueByPath } from '@/shared/utils/object'\n\nexport function useCollabAnyDataChange(room: CollabRoom, disableAutoUnsubscribe = false) {\n  const { collabOptions } = useCommonAdminCollabOptions()\n  const { currentUserId } = useCollabCurrentUserId()\n  const {\n    collabSocket,\n    collabFieldLocksState,\n    collabFieldDataBufferState,\n    collabRoomInfoState,\n    setFieldLockUnanswered,\n    fieldLockMaybeHeld,\n  } = useCollabStateInternal()\n  const changeEventBus = useCollabRoomDataChangeEventBus()\n  const fieldLockStatusEventBus = useCollabFieldLockStatusEventBus()\n\n  const anyChangeCallback = ref<undefined | ((field: CollabFieldName, payload: CollabFieldDataEnvelope) => void)>()\n  const unsubscribeCollabAnyDataChangeListener = ref<undefined | Fn>()\n\n  const anyChangeEventBusListener = (event: CollabRoomDataChangedEvent, payload?: CollabFieldDataEnvelope) => {\n    if (event.room !== room || isUndefined(payload) || isUndefined(anyChangeCallback.value)) {\n      return\n    }\n    anyChangeCallback.value(event.field, payload)\n  }\n\n  const addCollabAnyDataChangeListener = (\n    callback: (field: CollabFieldName, data: CollabFieldDataEnvelope) => void\n  ) => {\n    anyChangeCallback.value = callback\n    unsubscribeCollabAnyDataChangeListener.value = changeEventBus.on(anyChangeEventBusListener)\n  }\n\n  const changeCollabAnyData = (field: CollabFieldName, data: CollabFieldData, callback: Fn | undefined = undefined) => {\n    if (!collabOptions.value.enabled || isUndefined(collabSocket.value)) return\n    const roomInfo = collabRoomInfoState.get(room)\n    if (roomInfo && roomInfo.status === CollabStatus.Inactive) return\n    collabSocket.value.emit('changeFieldData', room, field, data, () => {\n      if (!isUndefined(callback)) callback()\n    })\n  }\n\n  const objectSetDataByField = <T extends object>(\n    field: CollabFieldName,\n    data: CollabFieldDataEnvelope,\n    objectToUpdate: MaybeRef<T>\n  ) => {\n    const object = unref(objectToUpdate)\n    switch (data.type) {\n      case 'json':\n        {\n          objectSetValueByPath(object, field, cloneDeep(data.value))\n        }\n        break\n      default: {\n        objectSetValueByPath(object, field, data.value)\n      }\n    }\n  }\n\n  tryOnBeforeUnmount(() => {\n    if (disableAutoUnsubscribe) return\n    if (isDefined(unsubscribeCollabAnyDataChangeListener.value)) {\n      unsubscribeCollabAnyDataChangeListener.value()\n    }\n  })\n\n  const acquireCollabAnyLock = (field: CollabFieldName, options: Partial<CollabFieldLockOptions> = {}) => {\n    if (!collabOptions.value.enabled || isUndefined(collabSocket.value)) return\n    const roomInfo = collabRoomInfoState.get(room)\n    if (roomInfo && roomInfo.status === CollabStatus.Inactive) return\n    collabSocket.value\n      ?.timeout(1000)\n      .emit('acquireFieldLock', room, field, options, (error, response: CollabChangeRoomLockCallbackTypes) => {\n        const statusEvent: CollabFieldLockStatusEvent = { field, room }\n        if (error) setFieldLockUnanswered(room, field, true)\n        if (error || isCollabFailedChangeRoomLockCallback(response)) {\n          return void fieldLockStatusEventBus.emit(\n            statusEvent,\n            createFieldLockStatusPayload(CollabFieldLockType.Acquire, CollabFieldLockStatus.Failure)\n          )\n        }\n        if (isCollabSuccessChangeRoomLockCallback(response)) {\n          if (!collabFieldLocksState.has(room)) {\n            collabFieldLocksState.set(room, new Map())\n          }\n          const locks = new Map(response.locks ? Object.entries(response.locks) : [])\n          for (const [field, lock] of locks.entries()) {\n            collabFieldLocksState.get(room)?.set(field, lock)\n          }\n\n          return void fieldLockStatusEventBus.emit(\n            statusEvent,\n            createFieldLockStatusPayload(CollabFieldLockType.Acquire, CollabFieldLockStatus.Success)\n          )\n        }\n      })\n  }\n\n  const releaseCollabAnyLock = (\n    field: CollabFieldName,\n    data: CollabFieldData,\n    options: Partial<CollabFieldLockOptions> = {}\n  ) => {\n    if (!collabOptions.value.enabled || isUndefined(collabSocket.value)) return\n    const roomInfo = collabRoomInfoState.get(room)\n    if (roomInfo && roomInfo.status === CollabStatus.Inactive) {\n      if (!collabFieldDataBufferState.has(room)) {\n        collabFieldDataBufferState.set(room, new Map())\n      }\n      collabFieldDataBufferState.get(room)?.set(field, data)\n      // As in `useCollabField`: a lock held while the other editor left must be released on the server too.\n      if (!collabSocket.value.connected || !fieldLockMaybeHeld(room, field, currentUserId.value)) return\n    }\n    collabSocket.value\n      ?.timeout(1000)\n      .emit('releaseFieldLock', room, field, data, options, (error, response: CollabChangeRoomLockCallbackTypes) => {\n        const statusEvent: CollabFieldLockStatusEvent = { field, room }\n        if (error || isCollabFailedChangeRoomLockCallback(response)) {\n          return void fieldLockStatusEventBus.emit(\n            statusEvent,\n            createFieldLockStatusPayload(CollabFieldLockType.Release, CollabFieldLockStatus.Failure)\n          )\n        }\n        if (isCollabSuccessChangeRoomLockCallback(response)) {\n          setFieldLockUnanswered(room, field, false)\n          if (!collabFieldLocksState.has(room)) {\n            collabFieldLocksState.set(room, new Map())\n          }\n          if (response.locks) {\n            for (const field of Object.keys(response.locks)) {\n              collabFieldLocksState.get(room)?.delete(field)\n            }\n          }\n\n          return void fieldLockStatusEventBus.emit(\n            statusEvent,\n            createFieldLockStatusPayload(CollabFieldLockType.Release, CollabFieldLockStatus.Success)\n          )\n        }\n      })\n  }\n\n  return {\n    addCollabAnyDataChangeListener,\n    unsubscribeCollabAnyDataChangeListener,\n    changeCollabAnyData,\n    objectSetDataByField,\n    acquireCollabAnyLock,\n    releaseCollabAnyLock,\n  }\n}\n"],"mappings":";;;;;;;;;;AA4BA,SAAgBA,EAAuB,GAAkB,IAAyB,IAAO;CACvF,IAAM,EAAE,qBAAkBC,EAA4B,GAChD,EAAE,qBAAkBC,EAAuB,GAC3C,EACJ,iBACA,0BACA,+BACA,wBACA,2BACA,0BACEC,EAAuB,GACrBC,IAAiBC,EAAgC,GACjDC,IAA0BC,EAAiC,GAE3DC,IAAoBC,EAAsF,GAC1GC,IAAyCD,EAAoB,GAE7DE,KAA6B,GAAmC,MAAsC;EAC1G,AAAIC,EAAM,SAASC,KAAQC,EAAYC,CAAO,KAAKD,EAAYN,EAAkB,KAAK,KAGtFA,EAAkB,MAAMI,EAAM,OAAOG,CAAO;CAC9C;CAuHA,OAnFAC,QAAyB;EACvB,AAAIC,KACAC,EAAUR,EAAuC,KAAK,KACxDA,EAAuC,MAAM;CAEjD,CAAC,GA8EM;EACL,iCArHA,MACG;GAEH,AADA,EAAkB,QAAQS,GAC1B,EAAuC,QAAQf,EAAe,GAAGO,CAAyB;EAC5F;EAkHE;EACA,sBAjH2B,GAAwB,GAAuB,IAA2B,KAAA,MAAc;GACnH,IAAI,CAACS,EAAc,MAAM,WAAWN,EAAYO,EAAa,KAAK,GAAG;GACrE,IAAMC,IAAWC,EAAoB,IAAIV,CAAI;GAC7C,AAAIS,KAAYA,EAAS,WAAWE,EAAa,YACjDH,EAAa,MAAM,KAAK,mBAAmBR,GAAMY,GAAOC,SAAY;IAClE,AAAKZ,EAAYK,CAAQ,KAAGA,EAAS;GACvC,CAAC;EACH;EA2GE,uBAxGA,GACA,GACA,MACG;GACH,IAAMQ,IAASC,EAAMC,CAAc;GACnC,QAAQH,EAAK,MAAb;IACE,KAAK;KAED,EAAqBC,GAAQF,GAAOK,EAAUJ,EAAK,KAAK,CAAC;KAE3D;IACF,SACE,EAAqBC,GAAQF,GAAOC,EAAK,KAAK;GAElD;EACF;EA0FE,uBAjF4B,GAAwB,IAA2C,CAAC,MAAM;GACtG,IAAI,CAACN,EAAc,MAAM,WAAWN,EAAYO,EAAa,KAAK,GAAG;GACrE,IAAMC,IAAWC,EAAoB,IAAIV,CAAI;GAC7C,AAAIS,KAAYA,EAAS,WAAWE,EAAa,YACjDH,EAAa,OACT,QAAQ,GAAI,CAAC,CACd,KAAK,oBAAoBR,GAAMY,GAAOM,IAAU,GAAO,MAAgD;IACtG,IAAMC,IAA0C;KAAE;KAAO;IAAK;IAE9D,IADIC,KAAOC,EAAuBrB,GAAMY,GAAO,EAAI,GAC/CQ,KAASE,EAAqCC,CAAQ,GACjD,EAA6B,KAClCJ,GACAK,EAA6BC,EAAoB,SAASC,EAAsB,OAAO,CACzF;SAEF,IAAIC,EAAsCJ,CAAQ,GAAG;KACnD,AAAKK,EAAsB,IAAI5B,CAAI,KACjC4B,EAAsB,IAAI5B,mBAAM,IAAI,IAAI,CAAC;KAE3C,IAAM6B,IAAQ,IAAI,IAAIN,EAAS,QAAQ,OAAO,QAAQA,EAAS,KAAK,IAAI,CAAC,CAAC;KAC1E,KAAK,IAAM,CAACX,GAAOkB,MAASD,EAAM,QAAQ,GACxC,EAAsB,IAAI7B,CAAI,CAAC,EAAE,IAAIY,GAAOkB,CAAI;KAG3C,EAA6B,KAClCX,GACAK,EAA6BC,EAAoB,SAASC,EAAsB,OAAO,CACzF;IACF;GACF,CAAC;EACL;EAoDE,uBAjDA,GACA,GACA,IAA2C,CAAC,MACzC;GACH,IAAI,CAACnB,EAAc,MAAM,WAAWN,EAAYO,EAAa,KAAK,GAAG;GACrE,IAAMC,IAAWC,EAAoB,IAAIV,CAAI;GAC7C,AAAIS,KAAYA,EAAS,WAAWE,EAAa,aAC1CoB,EAA2B,IAAI/B,CAAI,KACtC+B,EAA2B,IAAI/B,mBAAM,IAAI,IAAI,CAAC,GAEhD+B,EAA2B,IAAI/B,CAAI,CAAC,EAAE,IAAIY,GAAOC,CAAI,GAEjD,CAACL,EAAa,MAAM,aAAa,CAACwB,EAAmBhC,GAAMY,GAAOqB,EAAc,KAAK,MAE3FzB,EAAa,OACT,QAAQ,GAAI,CAAC,CACd,KAAK,oBAAoBR,GAAMY,GAAOC,GAAMK,IAAU,GAAO,MAAgD;IAC5G,IAAMC,IAA0C;KAAE;KAAO;IAAK;IAC9D,IAAIC,KAASE,EAAqCC,CAAQ,GACjD,EAA6B,KAClCJ,GACAK,EAA6BC,EAAoB,SAASC,EAAsB,OAAO,CACzF;SAEF,IAAIC,EAAsCJ,CAAQ,GAAG;KAKnD,IAJAF,EAAuBrB,GAAMY,GAAO,EAAK,GACpCgB,EAAsB,IAAI5B,CAAI,KACjC4B,EAAsB,IAAI5B,mBAAM,IAAI,IAAI,CAAC,GAEvCuB,EAAS,OACX,KAAK,IAAMX,KAAS,OAAO,KAAKW,EAAS,KAAK,GAC5C,EAAsB,IAAIvB,CAAI,CAAC,EAAE,OAAOY,CAAK;KAI1C,EAA6B,KAClCO,GACAK,EAA6BC,EAAoB,SAASC,EAAsB,OAAO,CACzF;IACF;GACF,CAAC;EACL;CASA;AACF"}

package/dist/domains/collab/composables/collabField.d.ts

@@ -2,9 +2,11 @@ import { CollabFieldData, CollabFieldDataEnvelope, CollabFieldLockOptions, Colla
 import { CollabFieldLockStatusPayload } from './collabEventBus';
 import { Fn } from '@vueuse/core';
 /**
- * `reacquireWhenActive`: a lock the component asked for and has not released is asked for again whenever the room
- * turns active — back after a lost connection, whose server let it go, or joined by another editor while this one was
- * alone and asked for none. For a field that holds the lock while it has the focus.
+ * `reacquireWhenActive`: a lock the component requested and has
+ * not released is requested again whenever the room turns active.
+ * This covers a reconnect, where the server released it, and
+ * another editor joining while this one was alone and held none.
+ * For a field that holds the lock while focused.
  */
 export declare function useCollabField(room: CollabRoom, field: CollabFieldName, disableAutoUnsubscribe?: boolean, reacquireWhenActive?: boolean): {
     addCollabFieldDataChangeListener: (callback: (data: CollabFieldDataEnvelope) => void) => void;