Merge pull request #33 from IABTechLab/ajy-UID2-2227-Use-secure-signa…

…ls-instead-of-ESP

Use "Secure Signals" instead of "ESP"

.github/workflows/publish-secure-signal-examples.yml

@@ -25,14 +25,14 @@ jobs:
  id: meta
  uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
  with:
- images: ${{ env.REGISTRY }}/iabtechlab/uid2-esp-example-srvonly
+ images: ${{ env.REGISTRY }}/iabtechlab/uid2-secure-signals-example-srvonly
  tags: |
  type=sha,format=short
  type=raw,value=latest
  - name: Build and push Docker server_only image
  uses: docker/build-push-action@v2
  with:
- context: examples/google-esp-integration/server_only
+ context: examples/google-secure-signals-integration/server_only
  push: true
  tags: ${{ steps.meta.outputs.tags }}
  labels: ${{ steps.meta.outputs.labels }}
@@ -54,14 +54,14 @@ jobs:
  id: meta
  uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
  with:
- images: ${{ env.REGISTRY }}/iabtechlab/uid2-esp-example-jssdk
+ images: ${{ env.REGISTRY }}/iabtechlab/uid2-secure-signals-example-jssdk
  tags: |
  type=sha,format=short
  type=raw,value=latest
  - name: Build and push Docker standard image
  uses: docker/build-push-action@v2
  with:
- context: examples/google-esp-integration/with_sdk_v3
+ context: examples/google-secure-signals-integration/with_sdk_v3
  push: true
  tags: ${{ steps.meta.outputs.tags }}
  labels: ${{ steps.meta.outputs.labels }}

.github/workflows/release-secure-signal-examples-docker-image-server-only.yaml

@@ -18,18 +18,18 @@ jobs:
  uses: IABTechLab/uid2-shared-actions/.github/workflows/shared-increase-version-number.yaml@v2
  with:
  release_type: ${{ inputs.release_type }}
- working_dir: examples/google-esp-integration/server_only
+ working_dir: examples/google-secure-signals-integration/server_only
  secrets: inherit
 
- publishForESPExampleSrvOnly:
+ publishForSecureSignalsExampleSrvOnly:
  uses: IABTechLab/uid2-shared-actions/.github/workflows/shared-publish-to-docker-versioned.yaml@v2
  needs: incrementVersionNumber
  with: 
  new_version: ${{ needs.incrementVersionNumber.outputs.new_version }}
  image_tag: ${{ needs.incrementVersionNumber.outputs.image_tag }}
  release_type: ${{ inputs.release_type }}
- docker_file: examples/google-esp-integration/server_only/Dockerfile
- docker_context: examples/google-esp-integration/server_only
- docker_image_name: iabtechlab/uid2-esp-example-srvonly
+ docker_file: examples/google-secure-signals-integration/server_only/Dockerfile
+ docker_context: examples/google-secure-signals-integration/server_only
+ docker_image_name: iabtechlab/uid2-secure-signals-example-srvonly
  docker_registry: ghcr.io
  secrets: inherit

.github/workflows/release-secure-signal-examples-docker-image-standard.yaml

@@ -17,18 +17,18 @@ jobs:
  uses: IABTechLab/uid2-shared-actions/.github/workflows/shared-increase-version-number.yaml@v2
  with:
  release_type: ${{ inputs.release_type }}
- working_dir: examples/google-esp-integration/with_sdk_v3
+ working_dir: examples/google-secure-signals-integration/with_sdk_v3
  secrets: inherit
 
- publishForESPExampleJssdk:
+ publishForSecureSignalsExampleJssdk:
  uses: IABTechLab/uid2-shared-actions/.github/workflows/shared-publish-to-docker-versioned.yaml@v2
  needs: incrementVersionNumber
  with: 
  new_version: ${{ needs.incrementVersionNumber.outputs.new_version }}
  image_tag: ${{ needs.incrementVersionNumber.outputs.image_tag }}
  release_type: ${{ inputs.release_type }}
- docker_file: examples/google-esp-integration/with_sdk_v3/Dockerfile
- docker_context: examples/google-esp-integration/with_sdk_v3
- docker_image_name: iabtechlab/uid2-esp-example-jssdk
+ docker_file: examples/google-secure-signals-integration/with_sdk_v3/Dockerfile
+ docker_context: examples/google-secure-signals-integration/with_sdk_v3
+ docker_image_name: iabtechlab/uid2-secure-signals-example-jssdk
  docker_registry: ghcr.io
  secrets: inherit

.vscode/launch.json

@@ -27,14 +27,14 @@
  "postDebugTask": "Terminate Prebid CSTG"
  },
  {
- "name": "Launch ESP (Chrome)",
+ "name": "Launch Secure Signals (Chrome)",
  "type": "chrome",
  "request": "launch",
  "url": "http://localhost:9090",
  "webRoot": "${workspaceRoot}/",
  "sourceMaps": true,
- "preLaunchTask": "Start ESP",
- "postDebugTask": "Terminate ESP",
+ "preLaunchTask": "Start Secure Signals",
+ "postDebugTask": "Terminate Secure Signals",
  "sourceMapPathOverrides": {
  "webpack://@uid2/uid2-sdk/./*": "${webRoot}/*"
  }

.vscode/settings.json

@@ -11,7 +11,7 @@
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
- "source.fixAll.eslint": true
+ "source.fixAll.eslint": "explicit"
  },
  "editor.tabSize": 2
 }

.vscode/tasks.json

@@ -37,11 +37,11 @@
  }
  },
  {
- "label": "Build ESP Image",
+ "label": "Build Secure Signals Image",
  "type": "docker-build",
  "dockerBuild": {
- "context": "${workspaceFolder}/examples/google-esp-integration/with_sdk_v3",
- "tag": "uid2-esp-example"
+ "context": "${workspaceFolder}/examples/google-secure-signals-integration/with_sdk_v3",
+ "tag": "uid2-secure-signals-example"
  }
  },
  {
@@ -110,12 +110,12 @@
  }
  },
  {
- "label": "Run ESP Container",
+ "label": "Run Secure Signals Container",
  "type": "docker-run",
- "dependsOn": ["Build ESP Image"],
+ "dependsOn": ["Build Secure Signals Image"],
  "dockerRun": {
- "image": "uid2-esp-example",
- "containerName": "uid2-esp-example",
+ "image": "uid2-secure-signals-example",
+ "containerName": "uid2-secure-signals-example",
  "ports": [
  {
  "hostPort": 9090,
@@ -124,12 +124,12 @@
  ],
  "volumes": [
  {
- "localPath": "${workspaceFolder}/examples/google-esp-integration/with_sdk_v3/views",
+ "localPath": "${workspaceFolder}/examples/google-secure-signals-integration/with_sdk_v3/views",
  "containerPath": "/usr/src/app/views",
  "permissions": "ro"
  }
  ],
- "envFiles": ["${workspaceFolder}/examples/google-esp-integration/with_sdk_v3/.env"],
+ "envFiles": ["${workspaceFolder}/examples/google-secure-signals-integration/with_sdk_v3/.env"],
  "remove": true
  }
  },
@@ -142,8 +142,8 @@
  "dependsOn": ["Run Prebid CSTG Container"]
  },
  {
- "label": "Start ESP",
- "dependsOn": ["webpack-dev-server", "Run ESP Container"]
+ "label": "Start Secure Signals",
+ "dependsOn": ["webpack-dev-server", "Run Secure Signals Container"]
  },
  {
  "label": "Terminate CSTG Container",
@@ -156,9 +156,9 @@
  "command": "docker stop uid2-prebid-cstg-example"
  },
  {
- "label": "Terminate ESP Container",
+ "label": "Terminate Secure Signals Container",
  "type": "shell",
- "command": "docker stop uid2-esp-example"
+ "command": "docker stop uid2-secure-signals-example"
  },
  {
  "label": "Terminate All Tasks",
@@ -175,8 +175,8 @@
  "dependsOn": ["Terminate All Tasks", "Terminate Prebid CSTG Container"]
  },
  {
- "label": "Terminate ESP",
- "dependsOn": ["Terminate All Tasks", "Terminate ESP Container"]
+ "label": "Terminate Secure Signals",
+ "dependsOn": ["Terminate All Tasks", "Terminate Secure Signals Container"]
  }
  ],
  "inputs": [

examples/google-esp-integration/server_only/README.md → examples/google-secure-signals-integration/server_only/README.md

@@ -1,4 +1,4 @@
-# Server-Only UID2 ESP Integration Example
+# Server-Only UID2 Secure Signals Integration Example
 
 This example demonstrates how a content publisher who is working with [Google Interactive Media Ads(IMA) SDKs](https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side) can use [Google Secure Signal](https://support.google.com/admanager/answer/10488752) to share UID2 directly with bidders, in a server-only implementation of UID2.
 
@@ -11,14 +11,14 @@ For an example application using the [Client-Side Identity JavaScript SDK](https
 The easiest way to try the example is to use the following Docker Build command:
 
 ```
-docker build . -t uid2-esp-server
+docker build . -t uid2-secure-signals-server
 docker run -it --rm -p 3000:3000 \
  -e UID2_BASE_URL="https://operator-integ.uidapi.com" \
  -e UID2_API_KEY="<your-integ-API-key>" \
  -e UID2_CLIENT_SECRET="<your-integ-client-secret>" \
  -e SESSION_KEY="<your-uid2-session-key>" \
  -e AD_TAG_URL="<your-IMA-ad-tag-url>" \
- uid2-esp-server
+ uid2-secure-signals-server
 ```
 
 The following table lists the environment variables that you must specify to start the application.

examples/google-esp-integration/server_only/package.json → examples/google-secure-signals-integration/server_only/package.json

@@ -1,6 +1,6 @@
 {
  "name": "uid2-publisher",
- "version": "1.0.0",
+ "version": "1.0.0-SNAPSHOT",
  "private": true,
  "license": "BSD-2-Clause",
  "engineStrict": true,

examples/google-esp-integration/server_only/views/header.html → examples/google-secure-signals-integration/server_only/views/header.html

@@ -32,7 +32,7 @@ <h1>Server-Only UID2 Integration Example</h1>
  <a href="https://unifiedid.com/docs/guides/google-ss-integration#server-only-integration"
  >Server-Only Integration</a
  >. [<a
- href="https://github.com/IABTechLab/uid2-web-integrations/tree/main/examples/google-esp-integration/server_only"
+ href="https://github.com/IABTechLab/uid2-web-integrations/tree/main/examples/google-secure-signals-integration/server_only"
  >Source Code</a
  >]
  </p>

examples/google-esp-integration/with_sdk_v3/README.md → examples/google-secure-signals-integration/with_sdk_v3/README.md

@@ -1,4 +1,4 @@
-# UID2 SDK ESP Integration Example
+# UID2 SDK Secure Signals Integration Example
 
 This example demonstrates how a content publisher who is working with [Google Interactive Media Ads(IMA) SDKs](https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side) can use [Google Secure Signal](https://support.google.com/admanager/answer/10488752) and the [Client-Side Identity JavaScript SDK](https://github.com/IABTechLab/uid2docs/blob/main/api/v2/sdks/client-side-identity.md) (also known as the UID2 SDK) to share UID2 directly with bidders, in an implementation that uses this SDK.
 
@@ -22,22 +22,22 @@ The easiest way to try the example is to do the following:
  UID2_JS_SDK_URL=http://localhost:9091/uid2-sdk.js
  ```
 1. Click the Run and Debug tab or hit `Crtl+Shift+D`
-1. Select `Launch ESP (Chrome)` from the configuration dropdown
+1. Select `Launch Secure Signals (Chrome)` from the configuration dropdown
 1. Click `Start Debugging` or hit F5
 
 ### Running the Docker commands manually
 
 The other way to try the example is to use the following Docker Build command. First, open this folder in your terminal, then run the following:
 
 ```
-docker build . -t uid2-esp-standard
+docker build . -t uid2-secure-signals-standard
 docker run -it --rm -p 3000:3000 `
  -e UID2_BASE_URL="https://operator-integ.uidapi.com" `
  -e UID2_API_KEY="<your-integ-API-key>" `
  -e UID2_CLIENT_SECRET="<your-integ-client-secret>" `
  -e AD_TAG_URL="https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/extrernal/adx-test-tag&tfcd=0&npa=0&sz=640x480&gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&impl=s&correlator=" `
  -e UID2_JS_SDK_URL="<your-JS-SDK-URL>" `
- uid2-esp-standard
+ uid2-secure-signals-standard
 ```
 
 The following table lists the environment variables that you must specify to start the application.

examples/google-esp-integration/with_sdk_v3/views/intro.html → examples/google-secure-signals-integration/with_sdk_v3/views/intro.html

@@ -9,7 +9,7 @@ <h1>Client-Side UID2 SDK Integration Example</h1>
  href="https://unifiedid.com/docs/guides/google-ss-integration#uid2-client-side-javascript-sdk-integration"
  >standard UID2 integration</a
  >. [<a
- href="https://github.com/IABTechLab/uid2-web-integrations/tree/main/examples/google-esp-integration/with_sdk_v3"
+ href="https://github.com/IABTechLab/uid2-web-integrations/tree/main/examples/google-secure-signals-integration/with_sdk_v3"
  >Source Code</a
  >]
 </p>