@cords/sdk 0.0.1

package/README.md

@@ -0,0 +1,77 @@
+# Cords API SDK
+
+The Cords API SDK provides a convenient way to interact with the Cords API, offering a set of methods to perform various operations such as searching, fetching related resources, and retrieving individual resources. This SDK is designed to simplify the process of integrating Cords API functionalities into your applications.
+
+## Installation
+
+You can install the SDK using npm or any other package manager:
+
+```bash
+npm install @cords/sdk
+```
+
+## Usage
+
+### Initialization
+
+First, import the `CordsAPI` function and initialize it with your API key:
+
+```javascript
+import { CordsAPI } from "@cords/sdk";
+
+const cords = CordsAPI({ apiKey: "your_api_key_here" });
+```
+
+### Searching
+
+To perform a search, use the `search` method. You can pass a query string and optional search options:
+
+```ts
+const results = await cords.search("query", {
+	page: 1,
+	lat: 40.7128,
+	lng: -74.006,
+	distance: 10,
+	pageSize: 20,
+	filter: {
+		211: true,
+		mentor: true,
+		prosper: true,
+		magnet: true,
+	},
+});
+```
+
+### Fetching Related Resources
+
+To fetch resources related to a specific resource, use the `related` method:
+
+```ts
+const relatedResources = await cords.related("resource_id");
+```
+
+### Retrieving a Single Resource
+
+To retrieve a single resource by its ID, use the `resource` method:
+
+```ts
+const resource = await cords.resource("resource_id");
+```
+
+### Fetching Multiple Resources
+
+To fetch multiple resources by their IDs, use the `resourceList` method:
+
+```ts
+const resources = await cords.resourceList(["resource_id_1", "resource_id_2"]);
+```
+
+### Formatting Service Address
+
+The SDK also includes a utility function to format service addresses:
+
+```ts
+import { formatServiceAddress } from "@cords/sdk";
+
+const formattedAddress = formatServiceAddress(resource.data.address)
+```

package/dist/index.d.mts

@@ -0,0 +1,79 @@
+type ResourceAddressType$1 = {
+    street1: string;
+    street2: string;
+    city: string;
+    postalCode: string;
+    province: string;
+    country: string;
+    lat: number | null;
+    lng: number | null;
+};
+
+type LocalizedFieldType = {
+    en: string;
+    fr: string;
+};
+type ResourceAddressType = {
+    street1: string;
+    street2: string;
+    city: string;
+    postalCode: string;
+    province: string;
+    country: string;
+    lat: number | null;
+    lng: number | null;
+};
+type ResourceType = {
+    id: string;
+    name: LocalizedFieldType;
+    description: LocalizedFieldType;
+    website: LocalizedFieldType;
+    email: LocalizedFieldType;
+    address: ResourceAddressType;
+    addresses: ResourceAddressType[];
+    phoneNumbers: {
+        phone: string;
+        name: string;
+        type: string;
+    }[];
+    partner: string;
+    delivery: "national" | "provincial" | "local" | "regional" | null;
+};
+type SearchOptions = {
+    page?: number;
+    lat?: number;
+    lng?: number;
+    distance?: number;
+    pageSize?: number;
+    filter?: {
+        "211"?: boolean;
+        mentor?: boolean;
+        prosper?: boolean;
+        magnet?: boolean;
+    };
+};
+type CordsError = {
+    detail: string;
+    status: number;
+    title: string;
+    type: string;
+};
+
+declare const ResourceOptions: {};
+declare const CordsAPI: ({ apiKey }: {
+    apiKey: string;
+}) => {
+    search: (q: string, options?: SearchOptions) => Promise<{
+        data: ResourceType[];
+    }>;
+    related: (id: string) => Promise<{
+        data: ResourceType[];
+    }>;
+    resource: (id: string) => Promise<ResourceType>;
+    resourceList: (ids: string[]) => Promise<{
+        data: ResourceType[];
+    }>;
+};
+declare const formatServiceAddress: (address: ResourceAddressType$1) => string;
+
+export { CordsAPI, type CordsError, type ResourceAddressType, ResourceOptions, type ResourceType, type SearchOptions, formatServiceAddress };

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+type ResourceAddressType$1 = {
+    street1: string;
+    street2: string;
+    city: string;
+    postalCode: string;
+    province: string;
+    country: string;
+    lat: number | null;
+    lng: number | null;
+};
+
+type LocalizedFieldType = {
+    en: string;
+    fr: string;
+};
+type ResourceAddressType = {
+    street1: string;
+    street2: string;
+    city: string;
+    postalCode: string;
+    province: string;
+    country: string;
+    lat: number | null;
+    lng: number | null;
+};
+type ResourceType = {
+    id: string;
+    name: LocalizedFieldType;
+    description: LocalizedFieldType;
+    website: LocalizedFieldType;
+    email: LocalizedFieldType;
+    address: ResourceAddressType;
+    addresses: ResourceAddressType[];
+    phoneNumbers: {
+        phone: string;
+        name: string;
+        type: string;
+    }[];
+    partner: string;
+    delivery: "national" | "provincial" | "local" | "regional" | null;
+};
+type SearchOptions = {
+    page?: number;
+    lat?: number;
+    lng?: number;
+    distance?: number;
+    pageSize?: number;
+    filter?: {
+        "211"?: boolean;
+        mentor?: boolean;
+        prosper?: boolean;
+        magnet?: boolean;
+    };
+};
+type CordsError = {
+    detail: string;
+    status: number;
+    title: string;
+    type: string;
+};
+
+declare const ResourceOptions: {};
+declare const CordsAPI: ({ apiKey }: {
+    apiKey: string;
+}) => {
+    search: (q: string, options?: SearchOptions) => Promise<{
+        data: ResourceType[];
+    }>;
+    related: (id: string) => Promise<{
+        data: ResourceType[];
+    }>;
+    resource: (id: string) => Promise<ResourceType>;
+    resourceList: (ids: string[]) => Promise<{
+        data: ResourceType[];
+    }>;
+};
+declare const formatServiceAddress: (address: ResourceAddressType$1) => string;
+
+export { CordsAPI, type CordsError, type ResourceAddressType, ResourceOptions, type ResourceType, type SearchOptions, formatServiceAddress };

package/dist/index.js

@@ -0,0 +1,168 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  CordsAPI: () => CordsAPI,
+  ResourceOptions: () => ResourceOptions,
+  formatServiceAddress: () => formatServiceAddress
+});
+module.exports = __toCommonJS(src_exports);
+var ResourceOptions = {};
+var baseUrl = "https://api.cords.ai";
+var CordsAPI = ({ apiKey }) => {
+  const request = (input, init) => __async(void 0, null, function* () {
+    const res = yield fetch(input, __spreadProps(__spreadValues({}, init), {
+      headers: __spreadValues({
+        "x-api-key": apiKey
+      }, init == null ? void 0 : init.headers)
+    }));
+    if (!res.ok) {
+      if (res.status === 403)
+        throw new Error("Bad API key. Ensure you have a valid API key.");
+      const data = yield res.json();
+      if (data.detail)
+        throw new Error(data.detail);
+      else
+        throw new Error("An error occurred");
+    }
+    return res;
+  });
+  const search = (q, options) => __async(void 0, null, function* () {
+    const url = new URL("/search", baseUrl);
+    const params = new URLSearchParams({
+      q
+    });
+    if ((options == null ? void 0 : options.page) !== void 0)
+      params.append("page", options.page.toString());
+    if ((options == null ? void 0 : options.lat) !== void 0)
+      params.append("lat", options.lat.toString());
+    if ((options == null ? void 0 : options.lng) !== void 0)
+      params.append("lng", options.lng.toString());
+    if ((options == null ? void 0 : options.distance) !== void 0)
+      params.append("distance", options.distance.toString());
+    if ((options == null ? void 0 : options.filter) !== void 0) {
+      for (const [key, value] of Object.entries(options.filter)) {
+        if (value)
+          params.append(`filter[${key}]`, "true");
+      }
+    }
+    const res = yield request(`${url}?${params}`);
+    const data = yield res.json();
+    return data;
+  });
+  const related = (id) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}/related`, baseUrl);
+    const res = yield request(`${url}`);
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    return data;
+  });
+  const resource = (id) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}`, baseUrl);
+    const res = yield fetch(url, {
+      headers: {
+        "x-api-key": apiKey
+      }
+    });
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    return data;
+  });
+  const resourceList = (ids) => __async(void 0, null, function* () {
+    if (ids.length === 0)
+      return {
+        data: []
+      };
+    const params = new URLSearchParams();
+    ids.forEach((id, index) => params.append(`ids[${index}]`, id));
+    const url = new URL(`/search?${params.toString()}`, baseUrl);
+    const res = yield fetch(`${url}`);
+    const data = yield res.json();
+    return data;
+  });
+  return {
+    search,
+    related,
+    resource,
+    resourceList
+  };
+};
+var formatServiceAddress = (address) => {
+  const street1 = address.street1 ? address.street1 + ", " : "";
+  const street2 = address.street2 ? address.street2 + ", " : "";
+  const city = address.city ? address.city + ", " : "";
+  const province = address.province ? address.province + ", " : "";
+  const postalCode = address.postalCode ? address.postalCode : "";
+  const newAddress = street1 + street2 + city + province + postalCode;
+  if (newAddress.endsWith(", ")) {
+    return newAddress.slice(0, -2);
+  } else
+    return newAddress;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CordsAPI,
+  ResourceOptions,
+  formatServiceAddress
+});

package/dist/index.mjs

@@ -0,0 +1,144 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var ResourceOptions = {};
+var baseUrl = "https://api.cords.ai";
+var CordsAPI = ({ apiKey }) => {
+  const request = (input, init) => __async(void 0, null, function* () {
+    const res = yield fetch(input, __spreadProps(__spreadValues({}, init), {
+      headers: __spreadValues({
+        "x-api-key": apiKey
+      }, init == null ? void 0 : init.headers)
+    }));
+    if (!res.ok) {
+      if (res.status === 403)
+        throw new Error("Bad API key. Ensure you have a valid API key.");
+      const data = yield res.json();
+      if (data.detail)
+        throw new Error(data.detail);
+      else
+        throw new Error("An error occurred");
+    }
+    return res;
+  });
+  const search = (q, options) => __async(void 0, null, function* () {
+    const url = new URL("/search", baseUrl);
+    const params = new URLSearchParams({
+      q
+    });
+    if ((options == null ? void 0 : options.page) !== void 0)
+      params.append("page", options.page.toString());
+    if ((options == null ? void 0 : options.lat) !== void 0)
+      params.append("lat", options.lat.toString());
+    if ((options == null ? void 0 : options.lng) !== void 0)
+      params.append("lng", options.lng.toString());
+    if ((options == null ? void 0 : options.distance) !== void 0)
+      params.append("distance", options.distance.toString());
+    if ((options == null ? void 0 : options.filter) !== void 0) {
+      for (const [key, value] of Object.entries(options.filter)) {
+        if (value)
+          params.append(`filter[${key}]`, "true");
+      }
+    }
+    const res = yield request(`${url}?${params}`);
+    const data = yield res.json();
+    return data;
+  });
+  const related = (id) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}/related`, baseUrl);
+    const res = yield request(`${url}`);
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    return data;
+  });
+  const resource = (id) => __async(void 0, null, function* () {
+    const url = new URL(`/resource/${id}`, baseUrl);
+    const res = yield fetch(url, {
+      headers: {
+        "x-api-key": apiKey
+      }
+    });
+    if (!res.ok) {
+      const data2 = yield res.json();
+      throw new Error(data2.detail);
+    }
+    const data = yield res.json();
+    return data;
+  });
+  const resourceList = (ids) => __async(void 0, null, function* () {
+    if (ids.length === 0)
+      return {
+        data: []
+      };
+    const params = new URLSearchParams();
+    ids.forEach((id, index) => params.append(`ids[${index}]`, id));
+    const url = new URL(`/search?${params.toString()}`, baseUrl);
+    const res = yield fetch(`${url}`);
+    const data = yield res.json();
+    return data;
+  });
+  return {
+    search,
+    related,
+    resource,
+    resourceList
+  };
+};
+var formatServiceAddress = (address) => {
+  const street1 = address.street1 ? address.street1 + ", " : "";
+  const street2 = address.street2 ? address.street2 + ", " : "";
+  const city = address.city ? address.city + ", " : "";
+  const province = address.province ? address.province + ", " : "";
+  const postalCode = address.postalCode ? address.postalCode : "";
+  const newAddress = street1 + street2 + city + province + postalCode;
+  if (newAddress.endsWith(", ")) {
+    return newAddress.slice(0, -2);
+  } else
+    return newAddress;
+};
+export {
+  CordsAPI,
+  ResourceOptions,
+  formatServiceAddress
+};

package/package.json

@@ -0,0 +1,24 @@
+{
+	"name": "@cords/sdk",
+	"main": "dist/index.js",
+	"module": "dist/index.mjs",
+	"types": "dist/index.d.ts",
+	"version": "0.0.1",
+	"private": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "tsup src/index.ts --format cjs,esm --dts",
+		"dev": "bun run build -- --watch"
+	},
+	"devDependencies": {
+		"@types/bun": "latest"
+	},
+	"peerDependencies": {
+		"typescript": "^5.0.0"
+	},
+	"dependencies": {
+		"tsup": "^8.0.2"
+	}
+}

package/src/index.ts

@@ -0,0 +1,113 @@
+import { ResourceAddressType } from "../dist";
+import type { CordsError, ResourceType, SearchOptions } from "./types";
+export * from "./types";
+
+export const ResourceOptions = {};
+
+const baseUrl = "https://api.cords.ai";
+
+export const CordsAPI = ({ apiKey }: { apiKey: string }) => {
+	const request = async (input: RequestInfo, init?: RequestInit) => {
+		const res = await fetch(input, {
+			...init,
+			headers: {
+				"x-api-key": apiKey,
+				...init?.headers,
+			},
+		});
+		if (!res.ok) {
+			if (res.status === 403)
+				throw new Error("Bad API key. Ensure you have a valid API key.");
+			const data: CordsError = await res.json();
+			if (data.detail) throw new Error(data.detail);
+			else throw new Error("An error occurred");
+		}
+		return res;
+	};
+
+	const search = async (q: string, options?: SearchOptions) => {
+		const url = new URL("/search", baseUrl);
+		const params = new URLSearchParams({
+			q,
+		});
+
+		// Add top-level parameters
+		if (options?.page !== undefined) params.append("page", options.page.toString());
+		if (options?.lat !== undefined) params.append("lat", options.lat.toString());
+		if (options?.lng !== undefined) params.append("lng", options.lng.toString());
+		if (options?.distance !== undefined) params.append("distance", options.distance.toString());
+
+		// Add filter parameters
+		if (options?.filter !== undefined) {
+			for (const [key, value] of Object.entries(options.filter)) {
+				if (value) params.append(`filter[${key}]`, "true");
+			}
+		}
+
+		const res = await request(`${url}?${params}`);
+		const data = await res.json();
+		return data as { data: ResourceType[] };
+	};
+
+	const related = async (id: string) => {
+		const url = new URL(`/resource/${id}/related`, baseUrl);
+
+		const res = await request(`${url}`);
+		if (!res.ok) {
+			const data: CordsError = await res.json();
+			throw new Error(data.detail);
+		}
+		const data = await res.json();
+		return data as { data: ResourceType[] };
+	};
+
+	const resource = async (id: string) => {
+		const url = new URL(`/resource/${id}`, baseUrl);
+
+		const res = await fetch(url, {
+			headers: {
+				"x-api-key": apiKey,
+			},
+		});
+		if (!res.ok) {
+			const data: CordsError = await res.json();
+			throw new Error(data.detail);
+		}
+		const data = await res.json();
+		return data as ResourceType;
+	};
+
+	const resourceList = async (ids: string[]): Promise<{ data: ResourceType[] }> => {
+		if (ids.length === 0)
+			return {
+				data: [],
+			};
+		const params = new URLSearchParams();
+		ids.forEach((id, index) => params.append(`ids[${index}]`, id));
+
+		const url = new URL(`/search?${params.toString()}`, baseUrl);
+
+		const res = await fetch(`${url}`);
+		const data = await res.json();
+		return data as { data: ResourceType[] };
+	};
+
+	return {
+		search,
+		related,
+		resource,
+		resourceList,
+	};
+};
+
+export const formatServiceAddress = (address: ResourceAddressType) => {
+	const street1 = address.street1 ? address.street1 + ", " : "";
+	const street2 = address.street2 ? address.street2 + ", " : "";
+	const city = address.city ? address.city + ", " : "";
+	const province = address.province ? address.province + ", " : "";
+	const postalCode = address.postalCode ? address.postalCode : "";
+	const newAddress = street1 + street2 + city + province + postalCode;
+	if (newAddress.endsWith(", ")) {
+		return newAddress.slice(0, -2);
+	} else return newAddress;
+};

package/src/types.ts

@@ -0,0 +1,53 @@
+type LocalizedFieldType = {
+	en: string;
+	fr: string;
+};
+
+export type ResourceAddressType = {
+	street1: string;
+	street2: string;
+	city: string;
+	postalCode: string;
+	province: string;
+	country: string;
+	lat: number | null;
+	lng: number | null;
+};
+
+export type ResourceType = {
+	id: string;
+	name: LocalizedFieldType;
+	description: LocalizedFieldType;
+	website: LocalizedFieldType;
+	email: LocalizedFieldType;
+	address: ResourceAddressType;
+	addresses: ResourceAddressType[];
+	phoneNumbers: {
+		phone: string;
+		name: string;
+		type: string;
+	}[];
+	partner: string;
+	delivery: "national" | "provincial" | "local" | "regional" | null;
+};
+
+export type SearchOptions = {
+	page?: number;
+	lat?: number;
+	lng?: number;
+	distance?: number;
+	pageSize?: number;
+	filter?: {
+		"211"?: boolean;
+		mentor?: boolean;
+		prosper?: boolean;
+		magnet?: boolean;
+	};
+};
+
+export type CordsError = {
+	detail: string;
+	status: number;
+	title: string;
+	type: string;
+};

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+	"compilerOptions": {
+		"target": "ES2016",
+		"module": "commonjs",
+		"esModuleInterop": true,
+		"forceConsistentCasingInFileNames": true,
+		"strict": true,
+		"skipLibCheck": true,
+		"noUncheckedIndexedAccess": true,
+		"noEmit": true
+	}
+}