shield360 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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/README.md

@@ -0,0 +1,310 @@
+<div align="center">
+<h3>OpenTelemetry-native</h3>
+<h1>AI Observability, Monitoring and Evaluation Framework</h1>
+
+**[Shield360](https://shield360.ai) | [Quickstart](#-getting-started-with-llm-observability) | [Report a Bug](https://github.com/ThinkfleetAI/shield360-js/issues/new)**
+
+[![npm](https://img.shields.io/npm/v/shield360)](https://www.npmjs.com/package/shield360)
+[![Downloads](https://img.shields.io/npm/dw/shield360)](https://www.npmjs.com/package/shield360)
+[![License](https://img.shields.io/badge/License-Apache%202.0-f80)](LICENSE)
+
+</div>
+
+Shield360 SDK is a monitoring framework built on top of **OpenTelemetry** that gives your complete Observability for your AI stack, from LLMs to vector databases, with just one line of code with tracing and metrics. It also allows you to send the generated traces and metrics to your existing monitoring tools like Grafana, New Relic, and more.
+
+This project proudly follows and maintains the [Semantic Conventions](https://github.com/open-telemetry/semantic-conventions/tree/main/docs/gen-ai) with the OpenTelemetry community, consistently updating to align with the latest standards in Observability.
+
+## ⚡ Features
+
+- 🔎 **Auto Instrumentation**: Works with 12+ LLM providers, vector databases, and AI frameworks with just one line of code.
+- 🔭 **OpenTelemetry-Native Observability SDKs**: Vendor-neutral SDKs that can send traces and metrics to your existing observability tool like Prometheus and Jaeger.
+- 💲 **Cost Tracking for Custom and Fine-Tuned Models**: Pass custom pricing files for accurate budgeting of custom and fine-tuned models.
+- 🚀 **Support for Shield360 Features**: Includes support for prompt management and secrets management features available in Shield360.
+
+
+## Auto Instrumentation Capabilities
+
+| LLMs                                                                                        |
+| ------------------------------------------------------------------------------------------- |
+| [✅ OpenAI](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/openai.mdx)                             |
+| [✅ Anthropic](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/anthropic.mdx)                       |
+| [✅ Cohere](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/cohere.mdx)                             |
+| [✅ Groq](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/groq.mdx)                                 |
+| [✅ Mistral](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/mistral.mdx)                           |
+| [✅ Google AI Studio](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/google-ai-studio.mdx)         |
+| [✅ Google Vertex AI](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/vertexai.mdx) *(via `@google-cloud/vertexai`)* |
+| [✅ Together AI](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/together.mdx)                      |
+| [✅ Ollama](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/ollama.mdx)                             |
+| [✅ AWS Bedrock](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/bedrock.mdx)                        |
+| [✅ Hugging Face](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/huggingface.mdx) *(Inference API + local Transformers.js)* |
+| [✅ Replicate](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/replicate.mdx)                      |
+| [✅ Azure OpenAI](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/azure-openai.mdx) *(via OpenAI SDK)* |
+
+| Audio / Speech                                                                              |
+| ------------------------------------------------------------------------------------------- |
+| [✅ ElevenLabs](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/elevenlabs.mdx)                   |
+
+| Vector Databases                                                                            |
+| ------------------------------------------------------------------------------------------- |
+| [✅ Chroma](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/chromadb.mdx)                           |
+| [✅ Pinecone](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/pinecone.mdx)                         |
+| [✅ Qdrant](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/qdrant.mdx)                             |
+| [✅ Milvus](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/milvus.mdx)                             |
+
+| Frameworks                                                                                  |
+| ------------------------------------------------------------------------------------------- |
+| [✅ LangChain](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/langchain.mdx)                       |
+| [✅ LlamaIndex](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/llama-index.mdx)                    |
+| [✅ Vercel AI SDK](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/integrations/vercel-ai.mdx)                   |
+
+## Supported Destinations
+
+- [✅ OpenTelemetry Collector](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/otelcol.mdx)
+- [✅ Prometheus + Tempo](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/prometheus-tempo.mdx)
+- [✅ Prometheus + Jaeger](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/prometheus-jaeger.mdx)
+- [✅ Grafana Cloud](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/grafanacloud.mdx)
+- [✅ New Relic](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/new-relic.mdx)
+- [✅ Elastic](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/elastic.mdx)
+- [✅ HyperDX](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/hyperdx.mdx)
+- [✅ DataDog](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/datadog.mdx)
+- [✅ SigNoz](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/signoz.mdx)
+- [✅ OneUptime](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/oneuptime.mdx)
+- [✅ Dynatrace](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/dynatrace.mdx)
+- [✅ OpenObserve](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/openobserve.mdx)
+- [✅ Highlight.io](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/highlight.mdx)
+
+## Supported Metrics
+
+The following metrics are supported across all integrations:
+
+- **genaiClientUsageTokens**: Histogram for total input/output tokens used.
+- **genaiClientOperationDuration**: Histogram for GenAI operation duration.
+- **genaiServerTbt**: Histogram for time per output token after the first token.
+- **genaiServerTtft**: Histogram for time to first token for successful responses.
+- **genaiRequests**: Counter for number of GenAI requests.
+- **genaiPromptTokens**: Counter for number of prompt tokens processed.
+- **genaiCompletionTokens**: Counter for number of completion tokens processed.
+- **genaiReasoningTokens**: Counter for number of reasoning thought tokens processed.
+- **genaiCost**: Histogram for distribution of GenAI request costs (USD).
+
+These metrics allow you to monitor usage, performance, and cost for supported GenAI operations.
+
+## 💿 Installation
+
+```bash
+npm install shield360
+```
+
+## 🚀 Getting Started
+
+### Step 1: Install Shield360
+
+Open your command line or terminal and run:
+
+```bash
+npm install shield360
+```
+
+### Step 2: Initialize Shield360 in your Application
+
+Integrate Shield360 into your AI applications by adding the following lines to your code.
+
+```typescript
+import Shield360 from 'shield360';
+
+Shield360.init();
+```
+
+Configure the telemetry data destination as follows:
+
+| Purpose                                   | Parameter/Environment Variable                   | For Sending to Shield360         |
+|-------------------------------------------|--------------------------------------------------|--------------------------------|
+| Send data to an HTTP OTLP endpoint        | `otlpEndpoint` or `OTEL_EXPORTER_OTLP_ENDPOINT` | `"http://127.0.0.1:4318"`     |
+| Authenticate telemetry backends           | `otlpHeaders` or `OTEL_EXPORTER_OTLP_HEADERS`   | Not required by default       |
+
+> 💡 Info: If the `otlp_endpoint` or `OTEL_EXPORTER_OTLP_ENDPOINT` is not provided, the Shield360 SDK will output traces directly to your console, which is recommended during the development phase.
+
+#### Example
+
+---
+
+<details>
+  <summary>Initialize using Function Arguments</summary>
+  
+  ---
+
+Add the following two lines to your application code:
+
+```typescript
+import Shield360 from 'shield360';
+
+Shield360.init({ 
+  otlpEndpoint: 'YOUR_OTEL_ENDPOINT',
+  otlpHeaders: 'YOUR_OTEL_ENDPOINT_AUTH'
+});
+```
+
+</details>
+
+---
+
+<details>
+
+  <summary>Initialize using Environment Variables</summary>
+
+---
+
+Add the following two lines to your application code:
+
+```typescript
+import Shield360 from "shield360"
+
+Shield360.init()
+```
+
+Then, configure the your OTLP endpoint using environment variable:
+
+```env
+export OTEL_EXPORTER_OTLP_ENDPOINT = "YOUR_OTEL_ENDPOINT"
+export OTEL_EXPORTER_OTLP_HEADERS = "YOUR_OTEL_ENDPOINT_AUTH"
+```
+
+</details>
+
+---
+
+### Step 3: Visualize and Optimize!
+Now that your LLM observability data is being collected and sent to configured OpenTelemetry destination, the next step is to visualize and analyze this data. This will help you understand your LLM application's performance and behavior and identify where it can be improved.
+
+If you want to use Shield360's Observability Dashboard to monitor LLM usage—like cost, tokens, and user interactions—please check out our [Quickstart Guide](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/quickstart-ai-observability.mdx).
+
+If you're sending metrics and traces to other observability tools, take a look at our [Connections Guide](https://github.com/ThinkfleetAI/shield360-js/blob/main/docs/destinations/overview.mdx) to start using a pre-built dashboard we have created for these tools.
+
+
+## Configuration
+
+### Observability - `Shield360.init()`
+
+Below is a detailed overview of the configuration options available, allowing you to adjust Shield360's behavior and functionality to align with your specific observability needs:
+
+| Argument                 | Description                                                                          | Default Value                                                      | Required |
+| ------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | -------- |
+| `environment`            | The deployment environment of the application.                                       | `"default"`                                                        | No      |
+| `applicationName`       | Identifies the name of your application.                                             | `"default"`                                                        | No      |
+| `tracer`                 | An instance of OpenTelemetry Tracer for tracing operations.                          | `undefined`                                                             | No       |
+| `otlpEndpoint`          | Specifies the OTLP endpoint for transmitting telemetry data.                         | `undefined`                                                             | No       |
+| `otlpHeaders`           | Defines headers for the OTLP exporter, useful for backends requiring authentication. | `undefined`                                                             | No       |
+| `disableBatch`          | A flag to disable batch span processing, favoring immediate dispatch.                | `true`                                                            | No       |
+| `traceContent`          | Enables tracing of content for deeper insights.                                      | `true`                                                             | No       |
+| `disabledInstrumentations` | List of instrumentations to disable.                                                    | `undefined`                                                             | No       |
+| `instrumentations`        | Object of instrumentation modules for manual patching                                          | `undefined`                                                            | No       |
+| `pricingJson`           | URL or file path of the pricing JSON file.                                           | Bundled `pricing.json` | No       |
+| `collectGpuStats`       | Flag to enable or disable GPU metrics collection (NVIDIA via `nvidia-smi`, AMD via `rocm-smi`). | `false`                                                            | No       |
+
+### Shield360 Prompt Hub - `Shield360.getPrompt()`
+
+Below are the parameters for use with the SDK for Shield360 Prompt Hub for prompt management:
+
+| Parameter        | Description                                                                                                                        |
+|------------------|------------------------------------------------------------------------------------------------------------------------------------|
+| `url`            | Sets the Shield360 URL. Defaults to the `SHIELD360_URL` environment variable or `http://127.0.0.1:3000` if not set.                    |
+| `apiKey`         | Sets the Shield360 API Key. Can also be provided via the `SHIELD360_API_KEY` environment variable.                                     |
+| `name`           | Sets the name to fetch a unique prompt. Use this or `promptId`.                                                                    |
+| `promptId`       | Sets the ID to fetch a unique prompt. Use this or `name`. Optional                                                                 |
+| `version`        | Sets the version to retrieve a specific prompt. Optional                                                                           | 
+| `shouldCompile`        | Boolean value that compiles the prompt using the provided variables. Optional                                                      |
+| `variables`      | Sets the variables for prompt compilation. Optional                                                                                | 
+| `metaProperties` | Sets the meta-properties for storing in the prompt's access history metadata.                                                      | 
+
+
+### Shield360 Vault - `Shield360.getSecrets()`
+
+Below are the parameters for use with the SDK for Shield360 Vault for secret management:
+
+| Parameter        | Description                                                                                                  |
+|------------------|------------------------------------------------------------------------------------------------------------------------------------|
+| `url`            | Sets the Shield360 URL. Defaults to the `SHIELD360_URL` environment variable or `http://127.0.0.1:3000` if not set.                    |
+| `apiKey`         | Sets the Shield360 API Key. Can also be provided via the `SHIELD360_API_KEY` environment variable.                                     |
+| `key`            | Sets the key to fetch a specific secret.     Optional                                                   |
+| `tags`       | Sets the tags for fetching only the secrets that have the mentioned tags assigned. Optional                      |
+| `shouldSetEnv`        | Boolean value that sets all the secrets as environment variables for the application. Optional                                                      |
+
+
+
+### Shield360 Rule Engine - `Shield360.evaluateRule()`
+
+Evaluate trace attributes against the Shield360 Rule Engine to retrieve matching rules and associated entities (contexts, prompts, evaluation configurations).
+
+| Parameter          | Description                                                                                                                        |
+|--------------------|------------------------------------------------------------------------------------------------------------------------------------|
+| `url`              | Sets the Shield360 URL. Defaults to the `SHIELD360_URL` environment variable or `http://127.0.0.1:3000`.                               |
+| `apiKey`           | Sets the Shield360 API Key. Can also be provided via the `SHIELD360_API_KEY` environment variable.                                     |
+| `entityType`       | Type of entity to match: `"context"`, `"prompt"`, or `"evaluation"`.                                                               |
+| `fields`           | Object of trace attributes to evaluate against rules. e.g. `{ "gen_ai.system": "openai" }`                                        |
+| `includeEntityData`| If `true`, include full entity data in the response. Default: `false`. Optional                                                    |
+| `entityInputs`     | Optional object of inputs for entity resolution (e.g. prompt variables).                                                           |
+
+#### Example
+
+```typescript
+import Shield360 from 'shield360';
+
+const result = await Shield360.evaluateRule({
+  entityType: 'context',
+  fields: {
+    'gen_ai.system': 'openai',
+    'gen_ai.request.model': 'gpt-4',
+    'service.name': 'my-app',
+  },
+  includeEntityData: true,
+});
+
+if (!('err' in result)) {
+  console.log('Matching rules:', result.matchingRuleIds);
+  console.log('Entities:', result.entities);
+}
+```
+
+### Score ingestion - `Shield360.logScore()`
+
+Attach numeric, boolean, or categorical scores and user feedback to a GenAI span. When called inside an instrumented LLM request, the score auto-attaches to the active span.
+
+| Parameter | Description |
+|-----------|-------------|
+| `name` | Score name, for example `user_feedback` or `quality`. |
+| `value` | Numeric, boolean, or categorical score value. |
+| `span` | Optional explicit OpenTelemetry span. |
+| `traceId` | Optional trace ID for async feedback against a past trace. |
+| `spanId` | Optional span ID for async feedback against a past trace. |
+| `comment` | Optional explanation or reviewer comment. |
+| `idempotencyKey` | Optional key to deduplicate score updates. |
+| `metadata` | Optional object of extra event attributes. |
+
+#### Example
+
+```typescript
+import Shield360 from 'shield360';
+
+Shield360.init();
+
+Shield360.logScore({ name: 'user_feedback', value: true, comment: 'Helpful response' });
+Shield360.logScore({ name: 'quality', value: 0.85, metadata: { reviewer: 'human' } });
+Shield360.logScore({ name: 'category', value: 'accurate' });
+```
+
+## 🌱 Contributing
+
+Whether it's big or small, we love contributions 💚. Check out our [Contribution guide](https://github.com/ThinkfleetAI/shield360-js#readme) to get started
+
+Unsure where to start? Here are a few ways to get involved:
+
+- Have a question or some feedback? Reach us at [shield360.ai](https://shield360.ai).
+
+Your input helps us grow and improve, and we're here to support you every step of the way.
+
+## 💚 Community & Support
+
+Connect with the Shield360 community and maintainers for support, discussions, and updates:
+
+- 🌟 If you like it, Leave a star on our [GitHub](https://github.com/ThinkfleetAI/shield360-js)
+- 🐞 Report bugs on our [GitHub Issues](https://github.com/ThinkfleetAI/shield360-js/issues) to help us improve Shield360.

package/dist/__tests__/manual-trace.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/manual-trace.test.js

@@ -0,0 +1,118 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const api_1 = require("@opentelemetry/api");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const config_1 = __importDefault(require("../config"));
+const semantic_convention_1 = __importDefault(require("../semantic-convention"));
+const manual_trace_1 = require("../manual-trace");
+describe('manual-trace', () => {
+    let exporter;
+    let provider;
+    beforeAll(() => {
+        exporter = new sdk_trace_base_1.InMemorySpanExporter();
+        provider = new sdk_trace_node_1.NodeTracerProvider({
+            spanProcessors: [new sdk_trace_base_1.SimpleSpanProcessor(exporter)],
+        });
+        provider.register();
+        config_1.default.updateConfig({
+            tracer: provider,
+            applicationName: 'TestApp',
+            environment: 'TestEnv',
+        });
+    });
+    beforeEach(() => {
+        exporter.reset();
+    });
+    afterAll(async () => {
+        await provider.shutdown();
+    });
+    it('startTrace nests child spans under the manual span', async () => {
+        await (0, manual_trace_1.startTrace)('parent-operation', async () => {
+            await api_1.trace.getTracer('shield360').startActiveSpan('child-llm', (child) => {
+                child.setAttribute('gen_ai.system', 'openai');
+                child.end();
+            });
+        });
+        const spans = exporter.getFinishedSpans();
+        expect(spans).toHaveLength(2);
+        const parentSpan = spans.find((s) => s.name === 'parent-operation');
+        const childSpan = spans.find((s) => s.name === 'child-llm');
+        expect(parentSpan).toBeDefined();
+        expect(childSpan).toBeDefined();
+        expect(childSpan.parentSpanContext?.spanId).toBe(parentSpan.spanContext().spanId);
+        expect(parentSpan.attributes[semantic_conventions_1.ATTR_SERVICE_NAME]).toBe('TestApp');
+        expect(parentSpan.attributes[semantic_convention_1.default.ATTR_DEPLOYMENT_ENVIRONMENT]).toBe('TestEnv');
+        expect(parentSpan.status.code).toBe(api_1.SpanStatusCode.OK);
+    });
+    it('startTrace nests child spans across await boundaries', async () => {
+        await (0, manual_trace_1.startTrace)('async-parent', async () => {
+            await Promise.resolve();
+            api_1.trace.getTracer('shield360').startActiveSpan('async-child', (child) => {
+                child.end();
+            });
+        });
+        const spans = exporter.getFinishedSpans();
+        const parentSpan = spans.find((s) => s.name === 'async-parent');
+        const childSpan = spans.find((s) => s.name === 'async-child');
+        expect(childSpan.parentSpanContext?.spanId).toBe(parentSpan.spanContext().spanId);
+    });
+    it('startTrace setResult and setMetadata stamp attributes', async () => {
+        await (0, manual_trace_1.startTrace)('metadata-test', async (span) => {
+            span.setResult('hello');
+            span.setMetadata({ 'custom.key': 'value', count: 3 });
+        });
+        const finished = exporter.getFinishedSpans()[0];
+        expect(finished.attributes[semantic_convention_1.default.GEN_AI_OUTPUT_MESSAGES]).toBe('hello');
+        expect(finished.attributes['custom.key']).toBe('value');
+        expect(finished.attributes.count).toBe(3);
+    });
+    it('trace() ends span on sync success and nests children', () => {
+        const result = (0, manual_trace_1.trace)('sync-chain', (span) => {
+            api_1.trace.getTracer('shield360').startActiveSpan('sync-child', (child) => {
+                child.end();
+            });
+            span.setResult('done');
+            return 42;
+        });
+        expect(result).toBe(42);
+        const spans = exporter.getFinishedSpans();
+        const parentSpan = spans.find((s) => s.name === 'sync-chain');
+        const childSpan = spans.find((s) => s.name === 'sync-child');
+        expect(childSpan.parentSpanContext?.spanId).toBe(parentSpan.spanContext().spanId);
+        expect(parentSpan.attributes[semantic_convention_1.default.GEN_AI_OUTPUT_MESSAGES]).toBe('done');
+        expect(parentSpan.status.code).toBe(api_1.SpanStatusCode.OK);
+    });
+    it('trace() ends span on async success', async () => {
+        const result = await (0, manual_trace_1.trace)('async-chain', async (span) => {
+            await Promise.resolve();
+            span.setResult('async-done');
+            return 'ok';
+        });
+        expect(result).toBe('ok');
+        const parentSpan = exporter.getFinishedSpans().find((s) => s.name === 'async-chain');
+        expect(parentSpan.attributes[semantic_convention_1.default.GEN_AI_OUTPUT_MESSAGES]).toBe('async-done');
+        expect(parentSpan.status.code).toBe(api_1.SpanStatusCode.OK);
+    });
+    it('trace() records errors and sets ERROR status', () => {
+        expect(() => (0, manual_trace_1.trace)('failing-sync', () => {
+            throw new Error('boom');
+        })).toThrow('boom');
+        const parentSpan = exporter.getFinishedSpans().find((s) => s.name === 'failing-sync');
+        expect(parentSpan.status.code).toBe(api_1.SpanStatusCode.ERROR);
+        expect(parentSpan.events.some((e) => e.name === 'exception')).toBe(true);
+    });
+    it('trace() records async rejection', async () => {
+        await expect((0, manual_trace_1.trace)('failing-async', async () => {
+            await Promise.resolve();
+            throw new Error('async-boom');
+        })).rejects.toThrow('async-boom');
+        const parentSpan = exporter.getFinishedSpans().find((s) => s.name === 'failing-async');
+        expect(parentSpan.status.code).toBe(api_1.SpanStatusCode.ERROR);
+    });
+});
+//# sourceMappingURL=manual-trace.test.js.map

package/dist/__tests__/manual-trace.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manual-trace.test.js","sourceRoot":"","sources":["../../src/__tests__/manual-trace.test.ts"],"names":[],"mappings":";;;;;AAAA,4CAAwE;AACxE,kEAGuC;AACvC,kEAAmE;AACnE,8EAAwE;AACxE,uDAAwC;AACxC,iFAAwD;AACxD,kDAAoD;AAEpD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,QAA8B,CAAC;IACnC,IAAI,QAA4B,CAAC;IAEjC,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,GAAG,IAAI,qCAAoB,EAAE,CAAC;QACtC,QAAQ,GAAG,IAAI,mCAAkB,CAAC;YAChC,cAAc,EAAE,CAAC,IAAI,oCAAmB,CAAC,QAAQ,CAAC,CAAC;SACpD,CAAC,CAAC;QACH,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACpB,gBAAe,CAAC,YAAY,CAAC;YAC3B,MAAM,EAAE,QAAe;YACvB,eAAe,EAAE,SAAS;YAC1B,WAAW,EAAE,SAAS;SACvB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,EAAE;QACd,QAAQ,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClB,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,IAAA,yBAAU,EAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,WAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC5E,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;gBAC9C,KAAK,CAAC,GAAG,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;QAC5D,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAChC,MAAM,CAAC,SAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,UAAW,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC;QACpF,MAAM,CAAC,UAAW,CAAC,UAAU,CAAC,wCAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,UAAW,CAAC,UAAU,CAAC,6BAAkB,CAAC,2BAA2B,CAAC,CAAC,CAAC,IAAI,CACjF,SAAS,CACV,CAAC;QACF,MAAM,CAAC,UAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,oBAAc,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,IAAA,yBAAU,EAAC,cAAc,EAAE,KAAK,IAAI,EAAE;YAC1C,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACxB,WAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,eAAe,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE;gBACxE,KAAK,CAAC,GAAG,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;QAChE,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;QAC9D,MAAM,CAAC,SAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,UAAW,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,IAAA,yBAAU,EAAC,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACxB,IAAI,CAAC,WAAW,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,6BAAkB,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrF,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,MAAM,GAAG,IAAA,oBAAK,EAAC,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE;YAC1C,WAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,eAAe,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE;gBACvE,KAAK,CAAC,GAAG,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxB,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC;QAC9D,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC;QAC7D,MAAM,CAAC,SAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,UAAW,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC;QACpF,MAAM,CAAC,UAAW,CAAC,UAAU,CAAC,6BAAkB,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvF,MAAM,CAAC,UAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,oBAAc,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAK,EAAC,aAAa,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACvD,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;QACrF,MAAM,CAAC,UAAW,CAAC,UAAU,CAAC,6BAAkB,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC7F,MAAM,CAAC,UAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,oBAAc,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,GAAG,EAAE,CACV,IAAA,oBAAK,EAAC,cAAc,EAAE,GAAG,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC,CAAC,CACH,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAElB,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC;QACtF,MAAM,CAAC,UAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,oBAAc,CAAC,KAAK,CAAC,CAAC;QAC3D,MAAM,CAAC,UAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,MAAM,CACV,IAAA,oBAAK,EAAC,eAAe,EAAE,KAAK,IAAI,EAAE;YAChC,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC,CAAC,CACH,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAEhC,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,CAAC;QACvF,MAAM,CAAC,UAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,oBAAc,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}