Feature/Discussion: CEP migration to UXP

README.md

@@ -1,5 +1,7 @@
 # Photoshop Integration
 
+## For information about this fork, Refer [Here](./client/ayon_photoshop/api/extension_uxp_develop/README.md)
+
 ### Implemented features
 
 - publishing workfile

extension_uxp/.gitignore

@@ -0,0 +1,138 @@
+# ---> Node
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+

extension_uxp/README.md

@@ -0,0 +1,62 @@
+# uxp-ayon-photoshop
+
+Migration of AYON CEP to UXP!
+
+It's a new way to do things.<br>
+Developed at Submarine, by Sas van Gulik, as commissioned by Thierry Paalman,<br>
+in order to let M-series Macs participate in projects without having to work off pipe due to CEP not being allowed on these platforms, and CEP being marked as deprecated.
+
+This fork is meant to open discussion on migrating or offering a CEP / UXP hybrid.
+
+This folder contains everything you need to start developing with the JS stubs provided by Adobe.
+
+Make sure that this directory (extension_uxp_develop) is your current directory, and
+simply run:
+
+`npm install`
+
+to download the packages present in the `package.json`.
+
+To use the plugin, you need to bundle it or "inject it" into photoshop while it's running.
+
+First of all, check which version ayon_photoshop expects to be in the manifest.
+This is the version that is found in `ayon_photoshop/api/extension/CSXS/manifest.xml`, <br>
+and you would be looking for ExtensionBundleVersion. As of writing this, 0.4.4+dev,
+the expected version is `1.1.11`. The bundled .ccx package has a baked in manifest version for 1.1.1 for example.
+
+Then you can adjust the manifest.json in `extension_uxp/manifest.json` to reflect
+this same version.
+
+Use the UXP developer tool (available in Adobe Creative Cloud desktop app) to develop or bundle this.
+[Docs on UXP Developer tools](https://developer.adobe.com/photoshop/uxp/2022/guides/devtool/)
+
+Using this tool you can either bundle the app after opening the folder with the manifest.json in it,
+or you can `Load & Watch` it while you are running photoshop from Ayon or anywhere else.
+
+If you bundle a .ccx, you can usually double click it to add it to your bundles,
+and it will automatically load on startup.
+
+### Note: This plugin is hardcoded to use a specific websocket port/adress:
+The adress we use is: `ws://localhost:8101/ws/`
+
+Modify Line 45 in `client/ayon_photoshop/api/webserver.py`
+
+```py
+# in class WebServerTool, __init__(...
+websocket_url = "ws://localhost:8101/ws/" # Line 45 original: os.getenv("WEBSOCKET_URL")
+```
+
+This is to cause no collision with the existing CEP plugin, but also because<br>
+**UXP Plugins can NOT read environment variables.**
+
+This, next to the need to EXPLICITLY allow `ws://localhost:8101` in the manifest allowed domains<br>
+('all' is not enough since that only counts for http / https connections),<br>
+makes it far less viable to dynamically inject a port number.
+
+When using the UXP plugin, this should be taken into account. 
+
+### Further setup documentation can be found in the NOTES: [Here!](./ayon_uxp/NOTES.MD)
+
+(It's quite complicated and different so I would recommend it.)
+
+Much love, Sas