@zeyos/cli 0.1.1

package/lib/resources.mjs

@@ -0,0 +1,234 @@
+/**
+ * Resource registry — maps CLI resource names to ZeyOS API operation IDs
+ * and defines sensible defaults for display fields.
+ *
+ * Naming rules
+ *  - Singular OR plural accepted  (ticket / tickets)
+ *  - Case-insensitive
+ *  - Common aliases supported
+ */
+
+// ── Registry ─────────────────────────────────────────────────────────────────
+
+/** @typedef {import('./types.mjs').ResourceDef} ResourceDef */
+
+/** @type {Record<string, ResourceDef>} */
+const REGISTRY = {
+  ticket: {
+    list:   'listTickets',
+    get:    'getTicket',
+    create: 'createTicket',
+    update: 'updateTicket',
+    delete: 'deleteTicket',
+    fields: ['ID', 'ticketnum', 'name', 'status', 'priority', 'duedate', 'lastmodified'],
+  },
+  task: {
+    list:   'listTasks',
+    get:    'getTask',
+    create: 'createTask',
+    update: 'updateTask',
+    delete: 'deleteTask',
+    fields: ['ID', 'tasknum', 'name', 'status', 'priority', 'duedate', 'ticket'],
+  },
+  account: {
+    list:   'listAccounts',
+    get:    'getAccount',
+    create: 'createAccount',
+    update: 'updateAccount',
+    delete: 'deleteAccount',
+    fields: ['ID', 'customernum', 'lastname', 'firstname', 'type', 'assigneduser', 'lastmodified'],
+  },
+  contact: {
+    list:   'listContacts',
+    get:    'getContact',
+    create: 'createContact',
+    update: 'updateContact',
+    delete: 'deleteContact',
+    fields: ['ID', 'firstname', 'lastname', 'email', 'phone', 'account'],
+  },
+  project: {
+    list:   'listProjects',
+    get:    'getProject',
+    create: 'createProject',
+    update: 'updateProject',
+    delete: 'deleteProject',
+    fields: ['ID', 'projectnum', 'name', 'status', 'assigneduser', 'lastmodified'],
+  },
+  appointment: {
+    list:   'listAppointments',
+    get:    'getAppointment',
+    create: 'createAppointment',
+    update: 'updateAppointment',
+    delete: 'deleteAppointment',
+    fields: ['ID', 'name', 'startdate', 'enddate', 'location'],
+  },
+  document: {
+    list:   'listDocuments',
+    get:    'getDocument',
+    create: 'createDocument',
+    update: 'updateDocument',
+    delete: 'deleteDocument',
+    fields: ['ID', 'name', 'doctype', 'docnum', 'account', 'date', 'nettotal'],
+  },
+  note: {
+    list:   'listNotes',
+    get:    'getNote',
+    create: 'createNote',
+    update: 'updateNote',
+    delete: 'deleteNote',
+    fields: ['ID', 'name', 'text', 'created'],
+  },
+  message: {
+    list:   'listMessages',
+    get:    'getMessage',
+    create: 'createMessage',
+    update: 'updateMessage',
+    delete: 'deleteMessage',
+    fields: ['ID', 'subject', 'sender', 'created', 'read'],
+  },
+  item: {
+    list:   'listItems',
+    get:    'getItem',
+    create: 'createItem',
+    update: 'updateItem',
+    delete: 'deleteItem',
+    fields: ['ID', 'itemnum', 'name', 'manufacturer', 'type', 'sellingprice', 'purchaseprice'],
+  },
+  user: {
+    list:   'listUsers',
+    get:    'getUser',
+    fields: ['ID', 'name', 'email', 'role', 'active'],
+  },
+  group: {
+    list:   'listGroups',
+    get:    'getGroup',
+    fields: ['ID', 'name', 'description'],
+  },
+  event: {
+    list:   'listEvents',
+    get:    'getEvent',
+    create: 'createEvent',
+    update: 'updateEvent',
+    delete: 'deleteEvent',
+    fields: ['ID', 'name', 'type', 'created', 'account'],
+  },
+  transaction: {
+    list:   'listTransactions',
+    get:    'getTransaction',
+    create: 'createTransaction',
+    update: 'updateTransaction',
+    delete: 'deleteTransaction',
+    fields: ['ID', 'name', 'amount', 'date', 'account'],
+  },
+  payment: {
+    list:   'listPayments',
+    get:    'getPayment',
+    create: 'createPayment',
+    update: 'updatePayment',
+    delete: 'deletePayment',
+    fields: ['ID', 'amount', 'date', 'method', 'transaction'],
+  },
+  opportunity: {
+    list:   'listOpportunities',
+    get:    'getOpportunity',
+    create: 'createOpportunity',
+    update: 'updateOpportunity',
+    delete: 'deleteOpportunity',
+    fields: ['ID', 'name', 'status', 'probability', 'amount', 'account'],
+  },
+  campaign: {
+    list:   'listCampaigns',
+    get:    'getCampaign',
+    create: 'createCampaign',
+    update: 'updateCampaign',
+    delete: 'deleteCampaign',
+    fields: ['ID', 'name', 'status', 'startdate', 'enddate'],
+  },
+  file: {
+    list:   'listFiles',
+    get:    'getFile',
+    create: 'createFile',
+    update: 'updateFile',
+    delete: 'deleteFile',
+    fields: ['ID', 'name', 'mimetype', 'filesize', 'created'],
+  },
+  invitation: {
+    list:   'listInvitations',
+    get:    'getInvitation',
+    create: 'createInvitation',
+    update: 'updateInvitation',
+    delete: 'deleteInvitation',
+    fields: ['ID', 'email', 'status', 'created'],
+  },
+  storage: {
+    list:   'listStorages',
+    get:    'getStorage',
+    create: 'createStorage',
+    update: 'updateStorage',
+    delete: 'deleteStorage',
+    fields: ['ID', 'name', 'type', 'capacity'],
+  },
+};
+
+// ── Aliases ───────────────────────────────────────────────────────────────────
+
+const ALIASES = {
+  // Plurals
+  tickets:      'ticket',
+  tasks:        'task',
+  accounts:     'account',
+  contacts:     'contact',
+  projects:     'project',
+  appointments: 'appointment',
+  documents:    'document',
+  doc:          'document',
+  docs:         'document',
+  notes:        'note',
+  messages:     'message',
+  items:        'item',
+  users:        'user',
+  groups:       'group',
+  events:       'event',
+  transactions: 'transaction',
+  payments:     'payment',
+  opportunities:'opportunity',
+  campaigns:    'campaign',
+  files:        'file',
+  invitations:  'invitation',
+  storages:     'storage',
+  // Colloquials
+  invoice:      'document',
+  invoices:     'document',
+  crm:          'account',
+  lead:         'opportunity',
+  leads:        'opportunity',
+};
+
+// ── Lookup ────────────────────────────────────────────────────────────────────
+
+/**
+ * Resolve a CLI resource name to a ResourceDef.
+ * Returns undefined if not found.
+ *
+ * @param {string} name  - e.g. "ticket", "tickets", "TICKET"
+ * @returns {ResourceDef|undefined}
+ */
+export function resolveResource(name) {
+  const lower = name.toLowerCase();
+  const canonical = ALIASES[lower] ?? lower;
+  return REGISTRY[canonical];
+}
+
+/**
+ * Return the canonical resource name for a given input.
+ * Returns undefined if not found.
+ */
+export function canonicalName(name) {
+  const lower = name.toLowerCase();
+  return ALIASES[lower] ?? (REGISTRY[lower] ? lower : undefined);
+}
+
+/** Return a sorted list of all canonical resource names. */
+export function listResources() {
+  return Object.keys(REGISTRY).sort();
+}

package/lib/types.mjs

@@ -0,0 +1,46 @@
+/**
+ * Shared JSDoc-only shapes for the CLI resource registry and field config.
+ * This file intentionally has no runtime exports beyond being an ESM module.
+ */
+
+/**
+ * @typedef {null|boolean|number|string|JsonValue[]|Record<string, JsonValue>} JsonValue
+ * @typedef {Record<string, JsonValue>} JsonObject
+ * @typedef {JsonObject} CliConfig
+ * @typedef {(value: JsonValue, row: JsonObject) => string|number|boolean|null|undefined} ValueFormatter
+ */
+
+/**
+ * @typedef {{
+ *   list: string,
+ *   get: string,
+ *   create?: string,
+ *   update?: string,
+ *   delete?: string,
+ *   fields: string[],
+ *   idField?: string
+ * }} ResourceDef
+ */
+
+/**
+ * @typedef {{
+ *   apiFields: Record<string,string>|undefined,
+ *   displayColumns: string[]
+ * }} ListFieldSelection
+ */
+
+/**
+ * @typedef {{
+ *   keys: string[],
+ *   labels: Record<string,string>
+ * }} GetFieldSelection
+ */
+
+/**
+ * @typedef {{
+ *   list?: { fields?: Record<string,string> },
+ *   get?: { fields?: string[], params?: Record<string, number|string|boolean> }
+ * }} ResourceFieldConfig
+ */
+
+export {};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@zeyos/cli",
+  "version": "0.1.1",
+  "description": "Command-line interface for the ZeyOS API",
+  "type": "module",
+  "license": "MIT",
+  "author": "Peter Haider <peter.haider@zeyos.com>",
+  "homepage": "https://github.com/zeyos/client/tree/main/cli#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zeyos/client.git",
+    "directory": "cli"
+  },
+  "bugs": {
+    "url": "https://github.com/zeyos/client/issues"
+  },
+  "keywords": [
+    "zeyos",
+    "cli",
+    "erp",
+    "crm",
+    "api"
+  ],
+  "bin": {
+    "zeyos": "bin/zeyos.mjs"
+  },
+  "exports": {
+    ".": "./bin/zeyos.mjs"
+  },
+  "files": [
+    "bin",
+    "commands",
+    "config",
+    "lib",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18.3"
+  },
+  "dependencies": {
+    "@zeyos/client": "^0.1.0"
+  },
+  "scripts": {
+    "test": "node --test test/offline.mjs"
+  }
+}