@questwork/q-inventory 0.1.0

package/src/components/QInventory.vue

@@ -0,0 +1,117 @@
+<template>
+  <div class="q-inventory">
+    <div class="q-inventory__toolbar">
+      <button
+        v-for="item in tabs"
+        :key="item.key"
+        class="q-inventory__tab"
+        :class="{ 'q-inventory__tab--active': activeTab === item.key }"
+        type="button"
+        @click="activeTab = item.key"
+      >
+        {{ item.label }}
+      </button>
+    </div>
+    <inventory-scanner
+      v-show="activeTab === 'scanner'"
+      :asset-api-client="assetApiClient"
+      :assets="assets"
+      :current-user-code="currentUserCode"
+      @moved="onMoved"
+      @scan="onScan"
+    />
+    <inventory-overview
+      v-if="activeTab === 'overview'"
+      :asset-api-client="assetApiClient"
+      :assets="assets"
+      :locations="locations"
+      @select-asset="onSelectAsset"
+      @select-location="onSelectLocation"
+    />
+    <inventory-asset-detail
+      v-if="activeTab === 'asset'"
+      :movement-api-client="movementApiClient"
+      :asset="selectedAsset"
+    />
+    <inventory-location-detail
+      v-if="activeTab === 'location'"
+      :asset-api-client="assetApiClient"
+      :location="selectedLocation"
+    />
+    <inventory-location-admin
+      v-if="activeTab === 'locations'"
+      :locations="locations"
+      @save-location="onSaveLocation"
+    />
+  </div>
+</template>
+
+<script setup lang="ts">
+import { computed, ref } from 'vue'
+import InventoryScanner from './InventoryScanner.vue'
+import InventoryOverview from './InventoryOverview.vue'
+import InventoryAssetDetail from './InventoryAssetDetail.vue'
+import InventoryLocationDetail from './InventoryLocationDetail.vue'
+import InventoryLocationAdmin from './InventoryLocationAdmin.vue'
+import type {
+  InventoryAssetApiClient,
+  InventoryLocationApiClient,
+  InventoryMovementApiClient,
+} from '../models/index.js'
+
+defineOptions({
+  name: 'q-inventory',
+})
+
+const props = defineProps<{
+  assetApiClient?: InventoryAssetApiClient
+  locationApiClient?: InventoryLocationApiClient
+  movementApiClient?: InventoryMovementApiClient
+  assets?: unknown[]
+  currentUserCode?: string
+  locations?: unknown[]
+}>()
+
+const emit = defineEmits<{
+  moved: [payload: unknown]
+  saveLocation: [payload: unknown]
+  scan: [payload: unknown]
+  selectAsset: [payload: unknown]
+  selectLocation: [payload: unknown]
+}>()
+
+const activeTab = ref('scanner')
+const selectedAsset = ref<unknown>(null)
+const selectedLocation = ref<unknown>(null)
+const tabs = computed(() => [
+  { key: 'scanner', label: 'Scan' },
+  { key: 'overview', label: 'Overview' },
+  { key: 'asset', label: 'Asset' },
+  { key: 'location', label: 'Location' },
+  { key: 'locations', label: 'Locations' },
+])
+
+function onMoved(payload: unknown) {
+  emit('moved', payload)
+}
+
+function onScan(payload: unknown) {
+  emit('scan', payload)
+}
+
+function onSaveLocation(payload: unknown) {
+  emit('saveLocation', payload)
+}
+
+function onSelectAsset(payload: unknown) {
+  selectedAsset.value = payload
+  activeTab.value = 'asset'
+  emit('selectAsset', payload)
+}
+
+function onSelectLocation(payload: unknown) {
+  selectedLocation.value = payload
+  activeTab.value = 'location'
+  emit('selectLocation', payload)
+}
+</script>

package/src/index.ts

@@ -0,0 +1,36 @@
+import type { App } from 'vue'
+import QInventory from './components/QInventory.vue'
+import InventoryScanner from './components/InventoryScanner.vue'
+import InventoryOverview from './components/InventoryOverview.vue'
+import InventoryAssetDetail from './components/InventoryAssetDetail.vue'
+import InventoryLocationDetail from './components/InventoryLocationDetail.vue'
+import InventoryLocationAdmin from './components/InventoryLocationAdmin.vue'
+import './styles/index.scss'
+
+export * from '@questwork/q-inventory-model'
+export * from './models/index.js'
+
+function install(app: App) {
+  app.component('q-inventory', QInventory)
+  app.component('inventory-scanner', InventoryScanner)
+  app.component('inventory-overview', InventoryOverview)
+  app.component('inventory-asset-detail', InventoryAssetDetail)
+  app.component('inventory-location-detail', InventoryLocationDetail)
+  app.component('inventory-location-admin', InventoryLocationAdmin)
+}
+
+QInventory.install = install
+
+export {
+  install,
+  InventoryAssetDetail,
+  InventoryLocationAdmin,
+  InventoryLocationDetail,
+  InventoryOverview,
+  InventoryScanner,
+  QInventory,
+}
+
+export default {
+  install,
+}

package/src/mixins/CSSMixin.ts

@@ -0,0 +1,14 @@
+export interface CssBlock {
+  block?: string
+  element?: string
+  modifier?: string
+}
+
+export function getCssBlock(base: string, css?: CssBlock): string[] {
+  return [
+    base,
+    css?.block,
+    css?.element,
+    css?.modifier,
+  ].filter(Boolean) as string[]
+}

package/src/models/index.ts

@@ -0,0 +1,114 @@
+import { InventoryAssetRepoAxios } from './inventoryAssetRepoAxios.js'
+import { InventoryLocationRepoAxios } from './inventoryLocationRepoAxios.js'
+import { InventoryMovementRepoAxios } from './inventoryMovementRepoAxios.js'
+import type { InventoryRepoAxiosOptions } from './inventoryAxiosBase.js'
+
+export interface InventoryAssetApiClient {
+  findAll?: (query?: Record<string, unknown>) => Promise<unknown[]>
+  findOne?: (id: string) => Promise<unknown[]>
+  saveOne?: (doc: Record<string, unknown>) => Promise<unknown>
+  move?: (payload: InventoryMovePayload) => Promise<unknown>
+}
+
+export interface InventoryLocationApiClient {
+  findAll?: (query?: Record<string, unknown>) => Promise<unknown[]>
+  findOne?: (id: string) => Promise<unknown[]>
+  saveOne?: (doc: Record<string, unknown>) => Promise<unknown>
+}
+
+export interface InventoryMovementApiClient {
+  findAll?: (query?: Record<string, unknown>) => Promise<unknown[]>
+}
+
+// Backward-compatible union type for consumers that still expect one object
+export type InventoryApiClient = InventoryAssetApiClient & InventoryLocationApiClient & InventoryMovementApiClient
+
+export interface InventoryMovePayload {
+  assetTag: string
+  fromLocationCode?: string
+  fromLocationKind?: string
+  movedBy?: string
+  toLocationCode: string
+  toLocationKind?: string
+  movementType?: string
+}
+
+export interface InventoryMoveWarning {
+  actualLocationCode?: string
+  assetTag?: string
+  code: string
+  message: string
+  requestedFromLocationCode?: string
+  requestedFromLocationKind?: string
+}
+
+export interface InventoryMoveResult {
+  warnings?: InventoryMoveWarning[]
+}
+
+export interface InventoryDisplayLocation {
+  code: string
+  label: string
+  type?: string
+}
+
+export * from './inventoryAxiosBase.js'
+export * from './inventoryAssetRepoAxios.js'
+export * from './inventoryAuthRepoAxios.js'
+export * from './inventoryLocationRepoAxios.js'
+export * from './inventoryMovementRepoAxios.js'
+
+// Backward-compat wrapper so existing callers don't break immediately.
+// Internally it delegates to the focused repos above.
+export class InventoryRepoAxios implements InventoryApiClient {
+  private assetRepo: InventoryAssetRepoAxios
+  private locationRepo: InventoryLocationRepoAxios
+  private movementRepo: InventoryMovementRepoAxios
+
+  constructor(options: InventoryRepoAxiosOptions = {}) {
+    this.assetRepo = new InventoryAssetRepoAxios(options)
+    this.locationRepo = new InventoryLocationRepoAxios(options)
+    this.movementRepo = new InventoryMovementRepoAxios(options)
+  }
+
+  async findAll(query?: Record<string, unknown>) {
+    return this.assetRepo.findAll(query)
+  }
+
+  async findOne(id: string) {
+    return this.assetRepo.findOne(id)
+  }
+
+  async saveOne(doc: Record<string, unknown>) {
+    return this.assetRepo.saveOne(doc)
+  }
+
+  async move(payload: InventoryMovePayload) {
+    return this.assetRepo.move(payload)
+  }
+
+  // Legacy alias for asset findAll
+  async findAssets(query?: Record<string, unknown>) {
+    return this.assetRepo.findAll(query)
+  }
+
+  // Legacy alias for location findAll
+  async findLocations(query?: Record<string, unknown>) {
+    return this.locationRepo.findAll(query)
+  }
+
+  // Legacy alias — location assets are just assets filtered by currentLocationCode
+  async findLocationAssets(locationCode: string) {
+    return this.assetRepo.findAll({ currentLocationCode: locationCode })
+  }
+
+  // Legacy alias for movement history
+  async findAssetHistory(assetTag: string) {
+    return this.movementRepo.findAll({ assetTag })
+  }
+
+  // Legacy alias for move
+  async moveAsset(payload: InventoryMovePayload) {
+    return this.assetRepo.move(payload)
+  }
+}

package/src/models/inventoryAssetRepoAxios.ts

@@ -0,0 +1,38 @@
+import { InventoryRepoAxiosBase, type InventoryRepoAxiosOptions } from './inventoryAxiosBase.js'
+import type { InventoryMovePayload } from './index.js'
+
+export interface InventoryAssetFindAllQuery extends Record<string, unknown> {
+  assetTag?: string
+  assetTags?: string[]
+  category?: string
+  currentLocationCode?: string
+  currentLocationKind?: string
+  currentLocationType?: string
+}
+
+export class InventoryAssetRepoAxios extends InventoryRepoAxiosBase {
+  constructor(options: InventoryRepoAxiosOptions = {}) {
+    super(options)
+  }
+
+  async findAll(query: InventoryAssetFindAllQuery = {}) {
+    return this.get('/qInventoryAsset', this.withDefaults(query))
+  }
+
+  async findOne(assetTag: string) {
+    return this.get(`/qInventoryAsset/${encodeURIComponent(assetTag)}`, this.withDefaults())
+  }
+
+  async saveOne(doc: Record<string, unknown>) {
+    return this.post('/qInventoryAsset', this.withDefaults(doc))
+  }
+
+  async move(payload: InventoryMovePayload) {
+    const assetTag = String(payload.assetTag || '')
+    const movedBy = payload.movedBy || this.movedBy
+    return this.post(`/qInventoryAsset/${encodeURIComponent(assetTag)}/move`, this.withDefaults({
+      ...payload,
+      movedBy,
+    }))
+  }
+}

package/src/models/inventoryAuthRepoAxios.ts

@@ -0,0 +1,48 @@
+import { InventoryRepoAxiosBase, type InventoryRepoAxiosOptions } from './inventoryAxiosBase.js'
+
+export interface InventoryTokenResult {
+  token: string
+  tokenExpiry: number
+}
+
+export interface InventoryLoginLinkResult {
+  email: string
+  loginUrl: string
+  sent: boolean
+}
+
+export interface InventoryUserTokenResult {
+  email: string
+  tenantCode: string
+  userCode: string
+  userToken: string
+}
+
+export class InventoryAuthRepoAxios extends InventoryRepoAxiosBase {
+  constructor(options: InventoryRepoAxiosOptions = {}) {
+    super(options)
+  }
+
+  async getBrowserToken() {
+    const result = await this.post('/qInventory/token', {
+      clientAppId: 'qInventoryBrowser',
+      clientAppName: 'qInventoryBrowser',
+    }) as { data?: InventoryTokenResult[] }
+    return result.data?.[0]
+  }
+
+  async requestLoginLink({ email, tenantCode = this.tenantCode }: { email: string, tenantCode?: string }) {
+    const result = await this.post('/qInventory/login-link', {
+      email,
+      tenantCode,
+    }) as { data?: InventoryLoginLinkResult[] }
+    return result.data?.[0]
+  }
+
+  async verifyLoginToken(loginToken: string) {
+    const result = await this.post('/qInventory/login-token/verify', {
+      loginToken,
+    }) as { data?: InventoryUserTokenResult[] }
+    return result.data?.[0]
+  }
+}

package/src/models/inventoryAxiosBase.ts

@@ -0,0 +1,149 @@
+export interface InventoryAxiosLike {
+  get: (url: string, config?: { headers?: Record<string, string>, params?: Record<string, unknown> }) => Promise<{ data: unknown }>
+  post: (url: string, body?: Record<string, unknown>, config?: { headers?: Record<string, string> }) => Promise<{ data: unknown }>
+}
+
+export interface InventoryRepoAxiosOptions {
+  axios?: InventoryAxiosLike
+  authenticatorTokenProvider?: () => Promise<string> | string
+  baseURL?: string
+  movedBy?: string
+  qRepo?: string
+  tenantCode?: string
+  userTokenProvider?: () => Promise<string> | string
+}
+
+export abstract class InventoryRepoAxiosBase {
+  axios?: InventoryAxiosLike
+  authenticatorTokenProvider?: () => Promise<string> | string
+  baseURL: string
+  movedBy: string
+  qRepo?: string
+  tenantCode: string
+  userTokenProvider?: () => Promise<string> | string
+
+  constructor(options: InventoryRepoAxiosOptions = {}) {
+    this.axios = options.axios
+    this.authenticatorTokenProvider = options.authenticatorTokenProvider
+    this.baseURL = (options.baseURL || '').replace(/\/$/, '')
+    this.movedBy = options.movedBy || 'currentUser'
+    this.qRepo = options.qRepo
+    this.tenantCode = options.tenantCode || 'tenantCode'
+    this.userTokenProvider = options.userTokenProvider
+  }
+
+  protected async get(path: string, query: Record<string, unknown> = {}) {
+    const headers = await this.getAuthHeaders()
+    if (this.axios) {
+      const response = await this.axios.get(this.getUrl(path), { headers, params: query })
+      return unwrapQSystemData(response.data)
+    }
+    const url = new URL(this.getUrl(path), getUrlBase())
+    Object.entries(query).forEach(([key, value]) => {
+      if (typeof value !== 'undefined' && value !== null && value !== '') {
+        url.searchParams.set(key, String(value))
+      }
+    })
+    const response = await fetch(this.getFetchUrl(url), { headers })
+    return unwrapQSystemData(await response.json(), response)
+  }
+
+  protected async post(path: string, body: Record<string, unknown> = {}) {
+    const headers = {
+      'Content-Type': 'application/json',
+      ...await this.getAuthHeaders(),
+    }
+    if (this.axios) {
+      const response = await this.axios.post(this.getUrl(path), body, { headers })
+      return unwrapQSystemResponse(response.data)
+    }
+    const response = await fetch(this.getUrl(path), {
+      body: JSON.stringify(body),
+      headers,
+      method: 'POST',
+    })
+    return unwrapQSystemResponse(await response.json(), response)
+  }
+
+  protected getUrl(path: string) {
+    return `${this.baseURL}/api/v1${path}`
+  }
+
+  protected getFetchUrl(url: URL) {
+    return this.baseURL ? url.toString() : `${url.pathname}${url.search}`
+  }
+
+  protected withDefaults(obj: Record<string, unknown> = {}) {
+    return removeEmptyValues({
+      ...obj,
+      qRepo: obj.qRepo || this.qRepo,
+      tenantCode: obj.tenantCode || this.tenantCode,
+    })
+  }
+
+  private async getAuthHeaders() {
+    const headers: Record<string, string> = {}
+    const authenticatorToken = await resolveTokenProvider(this.authenticatorTokenProvider)
+    const userToken = await resolveTokenProvider(this.userTokenProvider)
+    if (authenticatorToken) {
+      headers['X-Q-Authenticator'] = authenticatorToken
+    }
+    if (userToken) {
+      headers['X-Q-Inventory-User-Token'] = userToken
+    }
+    return headers
+  }
+}
+
+async function resolveTokenProvider(provider?: () => Promise<string> | string) {
+  if (!provider) {
+    return ''
+  }
+  return provider()
+}
+
+function unwrapQSystemResponse(json: unknown, response?: Response) {
+  const data = json as Record<string, unknown>
+  const err = data?.err as Record<string, unknown> | undefined
+  const errors = data?.errors as Record<string, unknown> | undefined
+  if ((response && !response.ok) || err?.hasError || errors) {
+    throw new Error(getResponseErrorMessage({ data, err, errors, response }))
+  }
+  return data
+}
+
+function unwrapQSystemData(json: unknown, response?: Response): unknown[] {
+  const data = unwrapQSystemResponse(json, response)
+  return Array.isArray(data?.data) ? data.data : []
+}
+
+function getUrlBase() {
+  if (typeof window !== 'undefined') {
+    return window.location.origin
+  }
+  return 'http://localhost'
+}
+
+function getResponseErrorMessage({ data, err, errors, response }: {
+  data: Record<string, unknown>
+  err?: Record<string, unknown>
+  errors?: Record<string, unknown>
+  response?: Response
+}) {
+  const code = String(response?.status || err?.statusCode || err?.code || errors?.name || data?.code || 'REQUEST_ERROR')
+  const message = formatErrorMessage(err?.message || errors?.message || data?.message || 'QInventory request failed')
+  return `${code}: ${message}`
+}
+
+function formatErrorMessage(value: unknown) {
+  if (Array.isArray(value)) {
+    return value.join('; ')
+  }
+  return String(value)
+}
+
+function removeEmptyValues(obj: Record<string, unknown>) {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([, value]) => typeof value !== 'undefined' && value !== null && value !== ''),
+  )
+}

package/src/models/inventoryLocationRepoAxios.ts

@@ -0,0 +1,25 @@
+import { InventoryRepoAxiosBase, type InventoryRepoAxiosOptions } from './inventoryAxiosBase.js'
+
+export interface InventoryLocationFindAllQuery extends Record<string, unknown> {
+  locationCode?: string
+  locationType?: string
+  parentLocationCode?: string
+}
+
+export class InventoryLocationRepoAxios extends InventoryRepoAxiosBase {
+  constructor(options: InventoryRepoAxiosOptions = {}) {
+    super(options)
+  }
+
+  async findAll(query: InventoryLocationFindAllQuery = {}) {
+    return this.get('/qInventoryLocation', this.withDefaults(query))
+  }
+
+  async findOne(locationCode: string) {
+    return this.get(`/qInventoryLocation/${encodeURIComponent(locationCode)}`, this.withDefaults())
+  }
+
+  async saveOne(doc: Record<string, unknown>) {
+    return this.post('/qInventoryLocation', this.withDefaults(doc))
+  }
+}

package/src/models/inventoryMovementRepoAxios.ts

@@ -0,0 +1,24 @@
+import { InventoryRepoAxiosBase, type InventoryRepoAxiosOptions } from './inventoryAxiosBase.js'
+
+export interface InventoryMovementFindAllQuery extends Record<string, unknown> {
+  assetTag?: string
+  fromLocationCode?: string
+  toLocationCode?: string
+  movedBy?: string
+  movementType?: string
+}
+
+export class InventoryMovementRepoAxios extends InventoryRepoAxiosBase {
+  constructor(options: InventoryRepoAxiosOptions = {}) {
+    super(options)
+  }
+
+  async findAll(query: InventoryMovementFindAllQuery = {}) {
+    const assetTag = String(query.assetTag || '')
+    if (!assetTag) {
+      throw new Error('assetTag is required for movement findAll')
+    }
+    const { assetTag: _omit, ...rest } = query
+    return this.get(`/qInventoryAsset/${encodeURIComponent(assetTag)}/movements`, this.withDefaults(rest))
+  }
+}