@glance-il/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Glance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,179 @@
+# @glance/sdk
+
+Official TypeScript SDK for the [Glance](https://www.glance.co.il) API — a fully-typed, ergonomic client for invoicing, inventory, and business management.
+
+## Installation
+
+```bash
+npm install @glance/sdk
+```
+
+## Quick Start
+
+```typescript
+import { GlanceClient } from "@glance/sdk";
+
+const glance = new GlanceClient({
+  apiKey: process.env.GLANCE_API_KEY!,
+});
+```
+
+## Usage Examples
+
+### List Clients
+
+```typescript
+const { data: clients, pagination } = await glance.clients.list({
+  search: "acme",
+  limit: 20,
+});
+
+console.log(`Found ${pagination.total} clients`);
+clients.forEach((c) => console.log(c.name));
+```
+
+### Create an Invoice
+
+```typescript
+const { data: invoice } = await glance.documents.create("invoice", {
+  clientId: "C-001",
+  products: [
+    {
+      description: "Web Development Services",
+      units: 40,
+      price: 150,
+      typeOfUnit: "hours",
+    },
+  ],
+  payments: [
+    {
+      amount: 6000,
+      paymentMethod: "bankTransfer",
+    },
+  ],
+  sendToClient: true,
+});
+
+console.log(`Invoice ${invoice.visibleId} created — total: ${invoice.totalWithTax}`);
+```
+
+### Manage Inventory
+
+```typescript
+// Adjust inventory for a product
+await glance.inventory.adjust("INV-001", {
+  quantity: 50,
+  warehouseId: "WH-001",
+  notes: "Initial stock",
+});
+
+// List inventory movements
+const { data: movements } = await glance.inventoryMovements.list({
+  warehouseId: "WH-001",
+  limit: 50,
+});
+```
+
+### Generate Reports
+
+```typescript
+const { data: report } = await glance.reports.income({
+  dateFrom: "2026-01-01",
+  dateTo: "2026-03-31",
+});
+
+console.log(`Revenue: ${report.total}`);
+```
+
+## Error Handling
+
+All API errors are typed and can be caught by class:
+
+```typescript
+import {
+  GlanceClient,
+  GlanceApiError,
+  GlanceAuthenticationError,
+  GlanceNotFoundError,
+  GlanceValidationError,
+  GlanceRateLimitError,
+} from "@glance/sdk";
+
+try {
+  const { data } = await glance.clients.get("non-existent");
+} catch (error) {
+  if (error instanceof GlanceNotFoundError) {
+    console.error("Client not found");
+  } else if (error instanceof GlanceValidationError) {
+    console.error("Validation failed:", error.message);
+  } else if (error instanceof GlanceAuthenticationError) {
+    console.error("Invalid API key");
+  } else if (error instanceof GlanceRateLimitError) {
+    console.error("Rate limit hit — retry after", error.retryAfter, "ms");
+  } else if (error instanceof GlanceApiError) {
+    console.error(`API Error ${error.status}: ${error.message} (${error.code})`);
+  }
+}
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and ships with full `.d.ts` declarations. All request and response types are exported:
+
+```typescript
+import type {
+  Client,
+  CreateClientParams,
+  GlanceDocument,
+  CreateDocumentParams,
+  Product,
+  PaginationMeta,
+} from "@glance/sdk";
+
+function processClient(client: Client): void {
+  console.log(`${client.name} — ${client.email}`);
+}
+```
+
+## Available Resources
+
+| Resource | Property | Description |
+|---|---|---|
+| Clients | `glance.clients` | Business clients / customers |
+| Contacts | `glance.contacts` | Contacts associated with clients |
+| Addresses | `glance.addresses` | Addresses for clients |
+| Products | `glance.products` | Products and services catalog |
+| Product Serials | `glance.productSerials` | Serial numbers for physical products |
+| Warehouses | `glance.warehouses` | Warehouse locations |
+| Inventory | `glance.inventory` | Stock levels per product/warehouse |
+| Inventory Movements | `glance.inventoryMovements` | Stock movement history |
+| Documents | `glance.documents` | Invoices, receipts, quotes, and more |
+| Vendors | `glance.vendors` | Suppliers and vendors |
+| Purchase | `glance.purchase` | Purchase orders and vendor invoices |
+| Expenses | `glance.expenses` | Business expenses |
+| Retainers | `glance.retainers` | Recurring retainer agreements |
+| Reports | `glance.reports` | Income, expenses, VAT reports |
+| Employees | `glance.employees` | Employee management |
+| Files | `glance.files` | File attachments |
+| Custom Fields | `glance.customFields` | Custom metadata fields |
+| Payments | `glance.payments` | Payment processing and transactions |
+| Settings | `glance.settings` | Account settings |
+
+## Configuration
+
+```typescript
+const glance = new GlanceClient({
+  apiKey: "your-api-key",   // required
+  baseUrl: "https://api.glance.co.il", // optional, defaults to production
+  timeout: 30_000,          // optional, milliseconds (default: 30s)
+});
+```
+
+## Requirements
+
+- Node.js >= 18 (uses native `fetch`)
+- TypeScript >= 5.0 (optional, works with plain JS too)
+
+## License
+
+MIT