@salesforce/lds-adapters-industries-nlpservice 1.114.3

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2022 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2022, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/package.json

@@ -0,0 +1,67 @@
+{
+    "name": "@salesforce/lds-adapters-industries-nlpservice",
+    "version": "1.114.3",
+    "description": "Ai Natural Language Processing Service",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "main": "dist/es/es2018/industries-nlpservice.js",
+    "module": "dist/es/es2018/industries-nlpservice.js",
+    "types": "dist/es/es2018/types/src/generated/artifacts/main.d.ts",
+    "files": [
+        "dist",
+        "sfdc",
+        "src/raml/*"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/es/es2018/types/src/generated/artifacts/main.d.ts",
+            "import": "./dist/es/es2018/industries-nlpservice.js",
+            "require": "./dist/es/es2018/industries-nlpservice.js"
+        },
+        "./sfdc": {
+            "types": "./sfdc/index.d.ts",
+            "import": "./sfdc/index.js",
+            "default": "./sfdc/index.js"
+        }
+    },
+    "sfdc": {
+        "namespace": "lightning",
+        "module": "industriesNlpserviceApi"
+    },
+    "contributors": [
+        "industries-einstein-hyd@salesforce.com"
+    ],
+    "scripts": {
+        "build": "yarn build:raml && yarn build:services && yarn build:karma",
+        "build:karma": "rollup --config rollup.config.karma.js",
+        "build:raml": "luvio generate src/raml/luvio.raml src/generated -p '../lds-compiler-plugins'",
+        "build:services": "rollup --config rollup.config.js",
+        "clean": "rm -rf dist sfdc src/generated karma/dist",
+        "release:core": "../../scripts/release/core.js --adapter=lds-adapters-industries-nlpservice",
+        "release:corejar": "yarn build && ../core-build/scripts/core.js --adapter=lds-adapters-industries-nlpservice",
+        "start": "karma start",
+        "test": "karma start --single-run",
+        "test:compat": "karma start --single-run --compat"
+    },
+    "dependencies": {
+        "@salesforce/lds-bindings": "*"
+    },
+    "devDependencies": {
+        "@salesforce/lds-karma": "*",
+        "@salesforce/lds-compiler-plugins": "*"
+    },
+    "nx": {
+        "targets": {
+            "build": {
+                "outputs": [
+                    "packages/lds-adapters-industries-nlpservice/dist",
+                    "packages/lds-adapters-industries-nlpservice/karma/dist",
+                    "packages/lds-adapters-industries-nlpservice/sfdc",
+                    "packages/lds-adapters-industries-nlpservice/src/generated"
+                ]
+            }
+        }
+    },
+    "volta": {
+        "extends": "../../package.json"
+    }
+}

package/src/raml/api.raml

@@ -0,0 +1,169 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '59.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v59.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  AINaturalLangProcessResultCollectionRepresentation:
+    description: The output representation of the list for AINaturalLangProcessResult
+    type: object
+    properties:
+      aiNaturalLangProcessResults:
+        description: Get a list of AINaturalLangProcessResult.
+        type: array
+        items:
+          type: AINaturalLangProcessResultRepresentation
+  AINaturalLangProcessResultInputWrapperRepresentation:
+    description: Wrapper for AINaturalLangProcessResultInputRepresentation.
+    type: object
+    properties:
+      aiNaturalLangProcessResultInputParam:
+        description: oas body name.
+        type: AINaturalLangProcessResultInputRepresentation
+  AINaturalLangProcessResultInputRepresentation:
+    description: Input representation for AINaturalLangProcessResult
+    type: object
+    properties:
+      query:
+        description: Query
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      serviceType:
+        description: Service Type
+        type: string
+        enum:
+          - OpenAIClauseExtraction
+          - OpenAIClauseGeneration
+          - OpenAIEntityRecognition
+        required: false # TODO Hand-rolled W-9314597
+  AINaturalLangProcessResultRepresentation:
+    description: The output representation of the AINaturalLangProcessResult
+    type: object
+    properties:
+      id:
+        description: The id of the AINaturalLangProcessResult record
+        type: string
+      requestText:
+        description: The Request Tex for the NLP operation
+        type: string | nil
+      response:
+        description: The Response of the NLP operation
+        type: object
+      serviceType:
+        description: The type of NLP service and operation
+        type: string
+      sourceRecord:
+        description: The original source record id on which the NLP operation was
+          performed
+        type: string | nil
+      status:
+        description: The Status of the NLP operation
+        type: string
+  ClauseStructRepresentation:
+    description: Details of a Clause
+    type: object
+    properties:
+      clauseName:
+        description: The name of the Clause
+        type: string
+      clauseText:
+        description: The text in the Clause
+        type: string
+  EntityStructRepresentation:
+    description: Details of an entity
+    type: object
+    properties:
+      entityName:
+        description: The name of the entity
+        type: string
+      entityValues:
+        description: The list of entities
+        type: array
+        items:
+          type: string
+  OpenAIClauseRepresentation:
+    description: Represents clause results fetched from OpenAI
+    type: object
+    properties:
+      clauseResults:
+        description: Represents a list of clauses
+        type: array
+        items:
+          type: ClauseStructRepresentation
+      totalResults:
+        description: Represents total number of clauses
+        type: integer
+  OpenAIEntityRepresentation:
+    description: Represents entity results fetched from OpenAI
+    type: object
+    properties:
+      entityResults:
+        description: Represents a list of entities
+        type: array
+        items:
+          type: EntityStructRepresentation
+      totalResults:
+        description: Represents total number of entities
+        type: integer
+/connect/nlp-service/aiNaturalLangProcessResults:
+  post:
+    displayName: postAINaturalLangProcessResult
+    description: Creates a AINaturalLangProcessResults record
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: AINaturalLangProcessResultRepresentation
+    body:
+      application/json:
+        # TODO Hand-rolled W-10128739. Original type: RecommendationInputRepresentation
+        type: AINaturalLangProcessResultInputWrapperRepresentation
+        (oas-body-name): aiNaturalLangProcessResultInputParam
+/connect/nlp-service/aiNaturalLangProcessResults/sourceRecords/{sourceRecordId}:
+  get:
+    displayName: getAINaturalLangProcessResultCollection
+    description: Gives the AINaturalLangProcessResults for a Source Record (Content
+      Document)
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: AINaturalLangProcessResultCollectionRepresentation
+    queryParameters:
+      serviceTypes:
+        type: array
+        required: false
+        items:
+          type: string
+          enum:
+            - OpenAIClauseExtraction
+            - OpenAIClauseGeneration
+            - OpenAIEntityRecognition
+          (oas-collectionFormat): csv
+  uriParameters:
+    sourceRecordId:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,28 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'NlpService'
+(luvio.ttl): 2592000000
+
+types:
+  AINaturalLangProcessResultCollectionRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  AINaturalLangProcessResultRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      serviceType: serviceType
+
+/connect/nlp-service/aiNaturalLangProcessResults:
+  post:
+    (luvio.adapter):
+      name: createAINaturalLangProcessResult
+
+/connect/nlp-service/aiNaturalLangProcessResults/sourceRecords/{sourceRecordId}:
+  get:
+    (luvio.adapter):
+      name: fetchAINaturalLangProcessResultsBySourceId