@eturkok/pliqra 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,7 @@
+Pliqra
+Copyright 2026 Pliqra contributors
+
+Original Pliqra source code, documentation, SDKs and examples are licensed
+under the Apache License, Version 2.0. See LICENSE for the full terms.
+
+Third-party dependencies retain their respective licenses and notices.

package/README.md

@@ -1,3 +1,21 @@
-# Temporary Holding Version
+# Pliqra JavaScript / TypeScript client
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Dependency-free ESM package for Node 22+ and modern browsers. TypeScript declarations are included. SDK versions have a separate lifecycle from gateway releases.
+
+```sh
+npm install @eturkok/pliqra@next
+```
+
+```js
+import {Pliqra, ContractChanged} from '@eturkok/pliqra';
+
+const client = new Pliqra('http://localhost:8088', process.env.PLIQRA_API_KEY);
+const connection = await client.connect('support', {requirements: ['chat', 'streaming']});
+for await (const chunk of connection.stream([{role: 'user', content: 'Hello'}])) {
+  process.stdout.write(chunk.choices?.[0]?.delta?.content || '');
+}
+```
+
+Changed contracts raise `ContractChanged` (HTTP 409). Rediscover/rebind deliberately. Streaming supports cancellation and rejects missing completion markers. The client does not forward credentials across redirects. Organizations use their `/org/slug` base URL. Model operations and batches are also supported.
+
+Use server-side secrets for applications; do not bundle privileged keys into a public browser application. The wire protocol remains draft 0.1; interoperability does not certify model quality or provider safety. See [Pliqra documentation](https://github.com/eturkok/pliqra/blob/main/docs/CONFORMANCE.md). Apache-2.0 licensed.

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@eturkok/pliqra",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Dependency-free Pliqra discovery, binding and inference client",
+  "type": "module",
+  "main": "./pliqra.mjs",
+  "types": "./pliqra.d.mts",
+  "exports": {
+    ".": {
+      "types": "./pliqra.d.mts",
+      "import": "./pliqra.mjs"
+    }
+  },
+  "files": [
+    "pliqra.mjs",
+    "pliqra.d.mts",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "license": "Apache-2.0",
+  "author": "Pliqra contributors",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eturkok/pliqra.git",
+    "directory": "sdk/javascript"
+  },
+  "homepage": "https://github.com/eturkok/pliqra",
+  "bugs": {
+    "url": "https://github.com/eturkok/pliqra/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "tag": "latest"
+  },
+  "keywords": [
+    "pliqra",
+    "llm",
+    "inference",
+    "gateway",
+    "protocol"
+  ]
+}

package/pliqra.d.mts

@@ -0,0 +1,20 @@
+export class PliqraError extends Error { status:number; detail:unknown; }
+export class ContractChanged extends PliqraError {}
+export type Message={role:'system'|'developer'|'user'|'assistant'|'tool'|'function';content?:unknown;[key:string]:unknown};
+export type Placement={routing?:'local_first'|'local_only'|'anywhere';allowed_sites?:string[];allowed_regions?:string[]};
+export type Binding={id:string;service:string;fingerprint:string;expires:number;invoke:string;extensions:string[];placement?:Placement};
+export class Pliqra {
+  constructor(baseURL:string,apiKey:string,options?:{fetch?:typeof fetch;timeout?:number});
+  request(path:string,body?:unknown,options?:{signal?:AbortSignal}):Promise<Response>;
+  json(path:string,body?:unknown,options?:{signal?:AbortSignal}):Promise<any>;
+  metadata():Promise<any>;
+  services():Promise<any[]>;
+  connect(service:string,options?:{requirements?:string[];ttlSeconds?:number;requiredExtensions?:string[];optionalExtensions?:string[]}):Promise<Connection>;
+}
+export class Connection {
+  binding:Binding;
+  complete(messages:Message[],parameters?:Record<string,unknown>):Promise<any>;
+  operation(operation:'embeddings'|'speech'|'transcription',parameters?:Record<string,unknown>):Promise<any|Uint8Array>;
+  batch(items:Record<string,unknown>[],options?:{name?:string;storeOutputs?:boolean}):Promise<any>;
+  stream(messages:Message[],parameters?:Record<string,unknown>,options?:{signal?:AbortSignal}):AsyncGenerator<any>;
+}

package/pliqra.mjs

@@ -0,0 +1,82 @@
+/** Dependency-free Pliqra client for Node 22+ and modern browsers. */
+export class PliqraError extends Error {
+  constructor(status, detail) { super(`HTTP ${status}: ${typeof detail === 'string' ? detail : JSON.stringify(detail)}`); this.status = status; this.detail = detail; }
+}
+export class ContractChanged extends PliqraError {}
+
+function localPath(path) {
+  if (typeof path !== 'string' || !path.startsWith('/') || path.startsWith('//') || path.includes('://') || path.includes('\\')) throw new Error('Protocol paths must be local');
+  return path;
+}
+async function bounded(response, limit = 16_000_000) {
+  const reader = response.body.getReader(); const parts = []; let size = 0;
+  try {
+    while (true) { const {done,value} = await reader.read(); if (done) break; size += value.byteLength; if (size > limit) throw new PliqraError(502,'Response exceeded its size limit'); parts.push(value); }
+  } finally { await reader.cancel().catch(()=>{}); reader.releaseLock(); }
+  const bytes = new Uint8Array(size); let offset = 0;
+  for (const part of parts) { bytes.set(part,offset); offset += part.length; }
+  return bytes;
+}
+export class Pliqra {
+  constructor(baseURL, apiKey, {fetch: transport = globalThis.fetch, timeout = 90_000} = {}) {
+    const url = new URL(baseURL);
+    if (!['http:','https:'].includes(url.protocol) || url.username || url.password || url.search || url.hash) throw new Error('Use an HTTP(S) base URL without credentials, query or fragment');
+    this.baseURL = baseURL.replace(/\/+$/,''); this.apiKey = apiKey; this.fetch = transport; this.timeout = timeout;
+  }
+  async request(path, body, {signal} = {}) {
+    const abort = signal ? AbortSignal.any([signal,AbortSignal.timeout(this.timeout)]) : AbortSignal.timeout(this.timeout);
+    const response = await this.fetch(this.baseURL + localPath(path), {method: body === undefined ? 'GET' : 'POST', headers: {'Authorization':`Bearer ${this.apiKey}`,'Content-Type':'application/json'}, body: body === undefined ? undefined : JSON.stringify(body), redirect:'error', credentials:'omit', signal:abort});
+    if (!response.ok) {
+      let detail = 'Protocol request failed';
+      try { detail = JSON.parse(new TextDecoder().decode(await bounded(response,200_000))).detail || detail; } catch {}
+      throw new (response.status === 409 ? ContractChanged : PliqraError)(response.status,detail);
+    }
+    return response;
+  }
+  async json(path,body,options) { return JSON.parse(new TextDecoder().decode(await bounded(await this.request(path,body,options)))); }
+  async metadata() {
+    if (!this.protocol) { this.protocol = await this.json('/.well-known/pliqra'); if (this.protocol.protocol !== 'pliqra/0.1-draft') throw new PliqraError(422,'Unsupported Pliqra protocol'); }
+    return this.protocol;
+  }
+  async services() { return (await this.json((await this.metadata()).discovery)).services; }
+  async connect(service,{requirements=['chat'],ttlSeconds=3600,requiredExtensions=[],optionalExtensions=[]}={}) {
+    const binding = await this.json((await this.metadata()).bind,{service,requirements,ttl_seconds:ttlSeconds,required_extensions:requiredExtensions,optional_extensions:optionalExtensions});
+    if (requiredExtensions.some(id=>!binding.extensions?.includes(id))) throw new PliqraError(422,'Server did not negotiate required extensions');
+    return new Connection(this,binding);
+  }
+}
+export class Connection {
+  constructor(client,binding) { this.client=client; this.binding=binding; }
+  async complete(messages,parameters={}) { return this.client.json(this.binding.invoke,{...parameters,model:this.binding.service,messages,stream:false}); }
+  async operation(operation,parameters={}) {
+    if (!this.binding.extensions?.includes('pliqra.operations/1')) throw new PliqraError(422,'Negotiate pliqra.operations/1 when connecting');
+    if (!['embeddings','speech','transcription'].includes(operation)) throw new Error('Unsupported operation');
+    const response=await this.client.request(`/protocol/v1/bindings/${encodeURIComponent(this.binding.id)}/operations/${operation}`,{...parameters,model:this.binding.service});
+    const bytes=await bounded(response,32_000_000);
+    return response.headers.get('content-type')?.includes('json') ? JSON.parse(new TextDecoder().decode(bytes)) : bytes;
+  }
+  async batch(items,{name='Application batch',storeOutputs=true}={}) {
+    if (!this.binding.extensions?.includes('pliqra.batches/1')) throw new PliqraError(422,'Negotiate pliqra.batches/1 when connecting');
+    return this.client.json('/api/v1/batches',{name,store_outputs:storeOutputs,items:items.map((item,index)=>({binding_id:this.binding.id,custom_id:String(index),body:{...item,model:this.binding.service}}))});
+  }
+  async *stream(messages,parameters={},options={}) {
+    const response=await this.client.request(this.binding.invoke,{...parameters,model:this.binding.service,messages,stream:true},options);
+    const reader=response.body.getReader(), decoder=new TextDecoder('utf-8',{fatal:true}); let buffer='', terminal=false, total=0;
+    try {
+      outer: while (true) {
+        const {done,value}=await reader.read(); if (done) { buffer+=decoder.decode(); break; }
+        total+=value.byteLength; if(total>16_000_000) throw new PliqraError(502,'Stream exceeded 16 MB');
+        buffer+=decoder.decode(value,{stream:true}); let end;
+        while ((end=buffer.indexOf('\n'))>=0) {
+          const line=buffer.slice(0,end).trim(); buffer=buffer.slice(end+1);
+          if(line.length>1_000_000)throw new PliqraError(502,'Stream line exceeded 1 MB');
+          if(!line.startsWith('data:'))continue;
+          const text=line.slice(5).trim(); if(text==='[DONE]'){terminal=true;break outer;} if(!text)continue;
+          const data=JSON.parse(text); if(data.error)throw new PliqraError(502,data.error.message || 'Stream failed'); yield data;
+        }
+        if(buffer.length>1_000_000)throw new PliqraError(502,'Stream line exceeded 1 MB');
+      }
+      if(!terminal)throw new PliqraError(502,'Stream ended without a completion marker');
+    } finally { await reader.cancel().catch(()=>{}); reader.releaseLock(); }
+  }
+}